Swagger

OpenAPI and Examples

How to use the public OpenAPI document, Swagger UI and request examples.

Version 1.0.0
Last updated 2026-05-26

OpenAPI source of truth

Use /developers/api/docs for the interactive reference and /developers/api/openapi.yaml for imports into:

  • Swagger UI
  • Postman
  • code generators

What is included

Only stable public APIs are documented there.

What is not included

  • internal admin APIs
  • billing internals
  • RBAC internals
  • raw authority payloads
  • tenant-only internal maintenance endpoints