Skip to main content
composerID has two APIs and one identifier that joins them. This page says which is which, how each authenticates and how their references are generated. Read it before the endpoint pages.

​
The two APIs

​
Which path does data take

A destination system receives only the Intent ID and a valid request. The evidence behind the decision takes a separate path to the people entitled to it.
  • Path 1, destinations. Beeline, SAP Fieldglass, Coupa, ServiceNow and the rest receive the Intent ID and a valid request. No answers, no scores, no timings ever reach a destination. The Intent API carries this path.
  • Path 2, the manuscript. The MSP needs the full diagnostic evidence for reporting. The Manuscript API and its webhooks serve it, never a destination.
The Intent ID (itn_..., up to 64 characters) is written into the manuscript’s externalId at creation and into the destination record at publish, so one identifier finds both halves in either direction, with no lookup table. Score and manuscript explains the boundary in full.

​
How these references are generated

Both references are generated from OpenAPI documents in the repository, so the pages cannot drift from the contract.
  • The Intent API document (api-reference/openapi.json, OpenAPI 3.1.0) is generated from the same registry that drives the destination pages, with every published JSON Schema embedded. The reference sandbox implements it exactly, and the conformance pack (python3 -m service.conformance) runs the documented claims against any base URL, in CI and on demand.
  • The Manuscript API document (api-reference/manuscript/openapi.json) is the vendor’s own, with operation names and summaries added for navigation.
The Intent API is served today by the reference sandbox, hosted at https://sandbox.composer.id/v1. The playground on each endpoint page calls it for real, so a request you try here reaches mock destination tenants rather than a live system. The production service behind api.composer.id is in build.

​
Next steps

Lifecycle

Mint, plan, preflight, publish and reconcile, one call at a time.

Manuscript API

Assessments, documents, surveys, workflows and signed webhooks.

Authentication

Credentials, scopes, token lifetime and errors.