API Explorer

An interactive Swagger UI bound to the live OpenAPI schema at /api/openapi.json. Expand any operation to see its parameters, request/response models, and to try it against your workspace.

Authorize first Most endpoints are permission-gated. Click Authorize and supply either an X-API-Key: cz_live_… workspace API key (recommended for integrations) or an Authorization: Bearer <jwt> from POST /api/v1/auth/login. In production the schema route itself is access-restricted (HTTP Basic auth) — ask your Carbon Zero administrator for credentials. The live equivalents served by the API are /api/docs (Swagger) and /api/redoc (ReDoc).