API reference

Endpoints

Base URL https://api.mopro-codex.com · Authentication Authorization: Bearer YOUR_API_KEY · Machine-readable spec at openapi.json.

Authentication

Every protected endpoint takes the same header. Keys are issued during the private beta by MMSx Authority — placeholder shown; never publish a real key.

HTTP header
Authorization: Bearer YOUR_API_KEY
Base URLhttps://api.mopro-codex.com
StatusPrivate Developer Beta

Quota headers

Every counted response returns your live quota position:

Response headers
X-MMSx-Plan: Professional
X-MMSx-Monthly-Limit: 50000
X-MMSx-Monthly-Used: 128
X-MMSx-Monthly-Remaining: 49872

Denied requests (401/403/429) are logged but never counted against quota.

Endpoint reference

GET /v3/ontology/healthpublic

Ontology and service health with dataset counts.

cURL
curl "https://api.mopro-codex.com/v3/ontology/health"
GET /v3/exercise/profileAPI key

Full exercise profile: identity, family, aliases, variations, graph domains, figure status.

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/profile?name=..."
Free Sandbox receives the basic tier (access_tier: "basic": trimmed aliases, no graph domains/figure requirement).
GET /v3/exercise/treeAPI key

Parent plus full child variation tree for a base exercise.

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/tree?name=..."
Developer plan and above.
GET /v3/exercise/childrenAPI key

Direct child variations only.

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/children?name=..."
Developer plan and above.
GET /v3/exercise/aliasesAPI key

All registered aliases for an exercise.

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/aliases?name=..."
Developer plan and above.
GET /v3/exercise/graph-domainsAPI key

Graph-domain biomechanics interpretation (modelled decision-support).

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/graph-domains?name=..."
Developer plan receives the basic tier: top domains only, no interpretation summary. Professional and above: full.
GET /v3/exercise/figuresAPI key

Figure requirement and figure status for an exercise.

Query parametername (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/exercise/figures?name=..."
Developer plan receives status only. Professional and above: full requirement record.
GET /v3/planspublic

Subscription plan catalogue with quotas and endpoint access levels.

cURL
curl "https://api.mopro-codex.com/v3/plans"
GET /v3/auth/key-statusAPI key

Status of the presented key: plan, limits, expiry, usage month.

cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/auth/key-status"
GET /v3/auth/usageAPI key

Recent request log for the presented key.

Query parameterlimit (required)
cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/auth/usage?limit=..."
GET /v3/auth/test-keyAPI key

Cheap authenticated ping to verify a key works.

cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/auth/test-key"
POST /v3/auth/revoke-keyAPI key

Self-revoke the presented key (admin can revoke by prefix).

cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/auth/revoke-key"
GET /v3/usage/monthlyAPI key

Month-by-month usage summary for the presented key.

cURL
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.mopro-codex.com/v3/usage/monthly"
POST /v3/auth/create-keyadmin token

Mint a new key. Admin token required (paid tiers). For a free key use /v3/auth/signup.

cURL
# Private beta: keys are minted by MMSx Authority.
# Admin token is never published; contact MMSx for access.
Envelope

Boundary fields on every payload

All exercise responses carry review_status, confidence, evidence_boundary and safety_boundary. Treat them as first-class data — surface them to end users where interpretation is shown.

GET /v3/ontology/health · 200 · JSON
{
  "review_status": "generated_ontology_ready_for_mmsx_expert_review",
  "confidence": 1.0,
  "evidence_boundary": "Generated ontology, ready for MMSx expert review. Do not claim all records are fully validated.",
  "safety_boundary": "Educational decision-support only; not medical diagnosis.",
  "ok": true,
  "base_exercise_count": 7000,
  "ontology_node_count": 35000,
  "edge_count": 28000,
  "alias_count": 14239,
  "search_term_count": 58490,
  "graph_delta_count": 199577,
  "figure_requirement_count": 35000,
  "review_queue_count": 16364,
  "status": "core_exercise_api_ready"
}