CueFrame
API reference

Shallow + deep health check

Shallow (default) returns 200 with a minimal liveness payload for load balancers. Append `?deep=1` to exercise component bindings (rate-limiter). Unauthenticated.

GET
/v1/health

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/health"
{  "status": "ok",  "version": "string",  "checks": {    "property1": {      "ok": true,      "detail": "string"    },    "property2": {      "ok": true,      "detail": "string"    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

OpenAPI 3.1 document for the v1 API GET

Returns the generated OpenAPI 3.1 document. Unauthenticated so SDK tooling (Orval, Postman, redocly) can fetch without a key. Cacheable for 5 minutes.

Return the caller identity + permissions GET

Echoes the `orgId`, `permissions`, and key metadata derived from the Authorization header (or x402 payment). Useful for SDKs to confirm which org a key is bound to and what permissions it carries.