API reference
Everything under this heading is generated from contracts/openapi.json — the same
document the server validates its own route table against at boot. An endpoint that
appears here is an endpoint that is mounted.
Contract version 0.1.0, 282 live operations (8 more are specified and not yet mounted).
The path carries no version segment. Breaking changes are not made, only additive
ones: a field is retired with a Deprecation header and a sunset date at least 180
days out, never by disappearing.
Catalogues
Section titled “Catalogues”Two closed vocabularies a client branches on, generated from the same contract:
- Error catalogue — 38 codes, each with its HTTP status and whether retrying can work.
- Event catalogue — the 13 stream frame types, protocol version 2.
Sections
Section titled “Sections”| Section | Operations |
|---|---|
| Runs | 16 |
| Sessions | 6 |
| Agents | 20 |
| Skills | 8 |
| Tools | 16 |
| Knowledge | 34 |
| Triggers | 23 |
| Events | 2 |
| Channels | 7 |
| Authentication | 19 |
| Organizations & workspaces | 35 |
| Billing | 9 |
| Alerts | 9 |
| Attachments | 2 |
| Code review | 13 |
| Evaluations | 3 |
| Feedback | 3 |
| Ingress | 2 |
| Knowledge maintenance | 9 |
| Mcp | 6 |
| Oauth | 12 |
| System | 13 |
Machine-readable forms
Section titled “Machine-readable forms”Your deployment serves the same contract three other ways:
GET /openapi.json— the OpenAPI 3.1 document.GET /redoc— an interactive browser for it.GET /llms.txt— the whole reference as plain text, for an editor or an agent.
Operator-only surfaces are excluded from this site. They are in the OpenAPI document.