v8

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-05-1633352.9 KB

Health

Liveness and basic configuration probe.

Unauthenticated, cheap, returns immediately. Does NOT verify downstream connectivity (Supabase, OpenRouter, Hydra) — it only reports whether the gateway process has booted with the expected config. Use this for container liveness checks; for readiness probes that include downstream health, build a higher-level check.

get/health

Response

Gateway is up. Response body describes the process — version, identity, configured planner model, recipe count, uptime. The 200 status is informational, not a health gate: read status and ready in the body to distinguish healthy from degraded.

versionstring required

Gateway package version, from gateway/package.json.

health'healthy' | 'degraded' | 'unhealthy' required

Overall classification.

healthy: every boot invariant satisfied, planner model resolves.
degraded: non-critical subsystem missing (reserved — no current signals trigger this).
unhealthy: a required invariant is broken (e.g. no planner model configured).

status'ok' | 'error' required

Two-state mirror of health — ok when healthy, error when unhealthy. Provided for operators that prefer binary.

readyboolean required

Liveness gate. True when every boot invariant is satisfied. Use this for k8s readiness probes via a jq post-processor.

uptime_secondsnumber required

Seconds since gateway process boot (float, 2 decimal places).

Example response

{
  "version": "0.1.0",
  "runtime": {
    "planner": {
      "model": "openrouter/anthropic/claude-sonnet-4.6",
      "provider": "openrouter",
      "model_id": "anthropic/claude-sonnet-4.6"
    },
    "recipe_count": 2
  },
  "application": {
    "gateway_did": "did:bindu:ops_at_example_com:gateway:f72ba681-f873-324c-6012-23c4d5b72451",
    "gateway_id": "f72ba681-f873-324c-6012-23c4d5b72451",
    "author": "ops_at_example_com"
  },
  "system": {
    "node_version": "v22.22.1",
    "platform": "darwin",
    "architecture": "arm64",
    "environment": "development"
  },
  "uptime_seconds": 23.3
}