API and contracts
Discover the running API and use explicit contracts at every boundary.
Open the local API reference
Start the combined development launcher, then open http://127.0.0.1:8000/docs in your browser. FastAPI provides an interactive reference for the actual running version.
The repository snapshot is contracts/openapi.json. Browser types are generated into apps/web/app/api.generated.ts. The Python schemas remain the implementation authority; generated files are checked for freshness.
Core interchange contracts
| Contract | Purpose |
|---|---|
| huggingbody/joint-angle-series@1.0.0 | Explicit joint, side, convention, seconds and degrees |
| huggingbody/joint-angle-summary@1.0.0 | Summary metrics and chart samples retaining source context |
| huggingbody/tabular-dataset@1.0.0 | Bounded numeric/categorical export for dashboard plots |
| huggingbody/motion@1 | Bounded movement coordinates in metres with right-handed Y-up axes |
| huggingbody/live-scene@1 | Ephemeral shared pose and camera packets |
Reference knee analysis
The reference input accepts 2–5,000 samples with strictly increasing times within 0–86,400 seconds and finite angles within −360–360 degrees. Side and flexion-positive convention are explicit.
Output metrics are minimum, maximum, range of motion and arithmetic sample mean. The mean is not time-weighted for irregular sampling. These metrics do not infer gait events, prescribe treatment or establish clinical progress.
Compatibility and errors
Unknown fields, invalid units, unsupported versions and incompatible bindings must return actionable errors. Do not silently coerce incompatible scientific data.
Version intentional breaking changes and retain a migration or compatibility path. Keep published definitions and accepted results immutable.