V2
OpenAPI
Use public OpenAPI document and metadata endpoints for generated clients and automation checks.
OpenAPI
The V2 API exposes a machine-readable OpenAPI document and a metadata endpoint for cache validation and automation.
Endpoints
| Endpoint | Description |
|---|---|
GET /v2/openapi.json |
Returns the machine-readable public OpenAPI document. |
GET /v2/openapi/meta |
Returns metadata for the OpenAPI document. |
/v2/openapi.json
Use this endpoint for generated clients, SDK generation, contract checks, and tooling. Prefer this machine-readable document over scraping documentation pages.
/v2/openapi/meta
{
"etag": "6a5f1dd9b429a0dc5f6ad1f2bb4d98473d0f69fe7db923b05ea4cf3fc3b71432",
"generatedAt": "2026-04-09T09:30:00.000Z",
"pathCount": 28,
"schemaCount": 107
}
| Field | Description |
|---|---|
etag |
SHA-256 digest of the serialized OpenAPI document for change detection. |
generatedAt |
Modification time of the resolved OpenAPI source in ISO 8601 format. |
pathCount |
Number of paths in the published document. |
schemaCount |
Number of component schemas in the published document. |
Recommended Usage
- Fetch
metafirst and downloadopenapi.jsononly when theetagchanges. - Use
openapi.jsonas the source for generated clients and CI checks. - Do not reverse-engineer API contracts from prose docs when OpenAPI contains the schema.
Notes
- Both OpenAPI routes are public and do not require a token.
- The OpenAPI document describes the non-destructive public V2 discovery surface. Supported soft-delete HTTP endpoints are documented in the Write section but intentionally omitted so MCP and CLI discovery do not expose destructive tools.
- Generated clients should still handle documented error responses.