Meta

The complete OpenAPI 3.1 description of this API, generated from the live routes.

Returns the OpenAPI 3.1 document for every endpoint: paths, request shapes, the scope each one requires, its cost tier, its MCP tool name and an example. Use it to generate a client or to check a request shape before sending it. Answers for any valid key. Read-only.

A markdown manual of this API, narrowed by default to what your key may call.

Returns a compact markdown document written to be pasted straight into an AI agent context: how to authenticate, the capabilities this key's scopes admit, the arguments each one takes, what each failure means and how to recover from it, the rate limits, and which actions need human confirmation. Narrowed to your own scopes unless you ask for scope=all. Call it once at startup instead of guessing paths. Read-only.

Confirm the API key is valid and report which workspace it belongs to.

Answers for any valid key regardless of its scopes, so it is the way to check a credential before doing anything else. Returns the authenticated user id and the server time. Read-only.

List every Public API endpoint with its scope, description and example.

Returns the machine-readable catalogue of this API: for each endpoint its method, path, required scope, what it does, when to use it, its side effect and a request example. Call it once at startup to discover the surface instead of guessing paths. Read-only.