The Compass /v1 API

Routes

• /v1/manifest.json: content release, per-card versions and hashes
• /v1/cards/index.json and /v1/cards/{code}.json: full card payloads (markdown answers, structured resources, citations, status display)
• /v1/domains/index.json and /v1/domains/{code}.json
• /v1/changelog.json: two changelogs, different audiences. releases is the version-level feed, listing per-card version changes for each tagged content release: it is the one to poll, and it is not rendered on /updates, which shows only the curated history. product_updates is that curated history, oldest first, one entry per reader-facing change with a permanent slug anchoring it on the page. It carries no commit, branch or file provenance by design.
• /v1/link-index.json: stable UUID-to-URL mapping with question anchors
• /v1/graph.json: the public knowledge graph (typed nodes/edges, provenance)
• /v1/regions.json: the region taxonomy (country and ISO 3166-2 subdivision codes, and whether reviewed content exists for a country yet)
• /v1/sources/index.json and /v1/sources/{id}.json: the public source registry with reverse usage (where each source is used and how)
• /v1/people/index.json and /v1/people/{id}.json, plus /v1/people/{region}/ for each supported region: the People library (who the professionals and support people in ALS/MND care are, what each may help with). There is no regions map. Each tree carries local content already resolved into it, so /v1/people/AU/{id}.json is the Australian picture and the top-level file is the general one. A region Compass does not support has no directory at all, and manifest.people.regions lists the ones that exist. An entry meaningful only in one country appears only in that country's tree. While publication_mode is prelaunch the library carries entries Compass has not finished checking, marked with a confirmation block; regional access and funding statements carry last_checked and must not be presented as settled.
• /v1/equipment/index.json and /v1/equipment/{id}.json: the equipment catalogue (cited dimension figures with provenance, verbatim manufacturer turning labels, reference-example attribution). Each figure is reviewed and published individually, so an item can appear with a measurement absent: treat a missing dimension key as unknown, never as zero. Where a figure carries a source_id, it resolves against /v1/sources/{id}.json. While publication_mode is prelaunch the catalogue also carries content Compass has not finished checking: those records and figures are marked with a confirmation block and confirmed: false, and must not be presented as settled.

Licence and attribution

Each payload carries a meta block: content_license applies to Compass-authored content only (CC BY 4.0 where stated: attribute "Compass, by Curalysis" and link the canonical URL; mark any adaptations as adapted). External resources keep their own rights; linked material is never covered by the Compass licence. Content is general information, not medical advice; payloads carry the standing disclaimer and it must be preserved in reuse.

Versioning and deprecation

Path-versioned: breaking changes mean /v2 with a 12-month overlap and Sunset headers on /v1; additive changes bump the payload schema_version minor. Card URLs and question anchors are permanent; codes are never reused. Only the current version of each card is published, plus the changelog; version identifiers in payloads support citation. Update slugs inproduct_updates are permanent once published, for the same reason card URLs are.

Schemas are published in the repository (packages/contracts).