DocumentationMotionCommons · Developer preview

API and contracts

Developer preview

Discover the running API and use explicit contracts at every boundary.

Docs/Reference
Ask Claude

API and contracts

Page Markdown

The complete guide, ready to copy or save as a Markdown file.

Download .md ↓

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

ContractPurpose
huggingbody/joint-angle-series@1.0.0Explicit joint, side, convention, seconds and degrees
huggingbody/joint-angle-summary@1.0.0Summary metrics and chart samples retaining source context
huggingbody/tabular-dataset@1.0.0Bounded numeric/categorical export for dashboard plots
huggingbody/motion@1Bounded movement coordinates in metres with right-handed Y-up axes
huggingbody/live-scene@1Ephemeral 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.

Accessibility

Make every MotionCommons page comfortable for you. Settings apply on this browser.

Text size

Your training, at your pace.

Reading & movement
Audio support

Spoken audio is unavailable in this browser. All instructions remain available as text.

Read this page speaks up to 1,800 characters of visible page text. Embedded dashboards have their own Read dashboard button.