API reference
Generated from the OpenAPI contract of the platform layer. Every operation appears here with the same ten parts and its release state.
The reference is generated, never typed. The source is the platform layer's openapi.json, produced from the running API and limited to partner operations. This site copies it with npm run sync:public-api and renders one page per operation under API in the sidebar, grouped by resource.
Released operations today
- 9 operations are prepared (Subjects, Consent, Sessions, Perception): the code exists, the contract is generated from it and verified in CI, but nothing is live for partners yet. Their pages carry a banner and the contract can still change before release. Internal operations (49 at the last sync) are excluded. The status page tracks each resource.
Resources
| Resource | What it is for |
|---|---|
| Subjects and consent | Manage the identity and permissions that constrain every other resource. |
| Sessions | Create and close bounded interaction contexts, inspect their processing status. |
| Perception | Submit or stream consented inputs, receive measured signals or an unavailable state. |
| Memory | Write and retrieve person-bound records with source and provenance intact. |
| Export and deletion | Request portable data and verifiable lifecycle operations. |
| Events | Receive asynchronous results, see Events. |
The ten parts of every endpoint
Each generated page carries these, in this order. If the contract lacks one, the build fails rather than publishing an incomplete page.
- Purpose in one sentence, with a link to the matching flow chart.
- Authentication and permission: which key, which scope, which consent condition must hold.
- Request: path, method, parameters, body with types, required and optional, example.
- Response: fields with types, "unavailable" as a documented state, example.
- Errors: every code with cause and action. Especially: consent missing, session closed, subject deleted.
- Pagination: cursor or page, sort order, maximum sizes.
- Rate limits: per key, per session, headers, behaviour on overflow.
- Idempotency: which calls are repeatable, the header name, how long a key is valid.
- Version policy: how the version is passed, lifetime, deprecation with date.
- Data protection note: which data the call touches, how long it stays, whether it can be exported and deleted.