Skip to main content

OpenAPI

Request/response schemas and a machine-readable description of the API are available via OpenAPI.

Document URL​

The live OpenAPI document is served at:

openapi/v1.json

Use this URL to:

  • Inspect endpoints, request bodies, and response shapes.
  • Generate client code or use with tools like Swagger UI or Postman.

If you host Swagger UI (e.g. in development or behind auth), point it at this URL for try-it-out style testing.