codai docs
API referenceGateway

Health

Unauthenticated liveness, readiness and catalog-status probes.

These three live at the root, not under /v1, and need no key. /health never touches the database; /health/ready runs the real auth-path query and returns 503 when any check fails — use that one for monitors.

GET
/health

Response Body

application/json

curl -X GET "https://example.com/health"
{  "ok": true,  "features": [    "frontier-tier"  ]}
GET
/health/ready

Response Body

application/json

application/json

curl -X GET "https://example.com/health/ready"
{  "ok": true,  "checks": {    "db": {      "ok": true,      "error": "string"    },    "schema": {      "ok": true,      "error": "string"    },    "registry": {      "ok": true,      "error": "string"    }  },  "s1": {    "mode": "off",    "ok": true,    "ms": 0,    "error": "string"  }}
GET
/status

Response Body

application/json

curl -X GET "https://example.com/status"
{  "ok": true,  "aliases": [    "codai",    "codai-fast",    "codai-embed"  ],  "providers": [    {      "id": "string",      "kind": "string",      "label": "string",      "healthy": true    }  ]}