Both API surfaces — the Enterprise API and SAPI-SK — are described by a single OpenAPI specification. It is not a hand-written document: it is produced from the route definitions themselves, and any drift between it and the code is caught by a test on the API side. What you download therefore matches what the server actually does.
Where to download it
| Address | Contents |
|---|---|
/openapi.json | The full specification, both APIs at once. |
/openapi/enterprise.json | Enterprise API only — paths under /api/v1, /api/auth, /health and /metrics. |
/openapi/sapi.json | SAPI-SK only — paths under /sapi. |
Try it interactively
The complete reference, with schemas, request and response examples and a Try it
button, lives at /docs. The Enterprise API is the default; SAPI-SK sits under
the /docs#sapi tab.
Generating a client
Any common generator accepts the specification (openapi-generator, orval, NSwag, Kiota).
Most operations carry an operationId, and that is what generators derive function names
from — createApiKey, listApiKeys, getBalance. We follow the same route ourselves:
the client the portal uses to call our own API is generated from this file.