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

The process is up.

application/json
  1. response
ok*true
Value intrue
features*array<string>

Append-only capability flags of the running image.

Example Request
curl -X GET 'https://ai.codai.ro/health'
Example Response200
{  "ok": true,  "features": [    "frontier-tier"  ]}
GET
/health/ready

Response Body

Every check passed.

application/json
  1. response
ok*boolean

True only when every entry in checks passed.

checks*
s1*

Informational reachability of the codai-s1 sidecar; never affects ok.

Example Request
curl -X GET 'https://ai.codai.ro/health/ready'
Example Response
{  "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

Registry snapshot.

application/json
  1. response
ok*true
Value intrue
aliases*array<string>

Every alias id in the live registry, including hidden internal ones.

providers*array<>
Example Request
curl -X GET 'https://ai.codai.ro/status'
Example Response200
{  "ok": true,  "aliases": [    "codai",    "codai-fast",    "codai-embed"  ],  "providers": [    {      "id": "string",      "kind": "string",      "label": "string",      "healthy": true    }  ]}

Last updated: