API reference
Every route an API key may call, generated from the API's own schemas.
The REST API answers under /api on the same host as the MCP endpoint. Every request is sent
with an API key, and each route needs one of the two
scopes and, for changes, the matching
permission.
The pages in this section are generated from the OpenAPI 3.1 document the API serves at
/api/openapi.json, so they always match what the API accepts. A refusal
answers with an HTTP status and a body of { "error": { "code", "message" } }, with an issues
entry for each problem where the request was wrong; each route's responses list the codes it
may answer with.
Prefer MCP for agents
An AI agent is better served by the MCP endpoint: its tools wrap these routes and come with the guidance on how to use them.