Health Check

Health check endpoint for monitoring and load balancers.

Returns status: "ok" only when an agent is registered and /agent/* will accept requests. Returns status: "degraded" with agent_ready: false when no agent is configured — e.g. standalone admin-only mode after an assemble_engine_config error, or the pre-onboarding wizard state. When app.state.boot_error is set by the standalone’s assembly failure handler, it is surfaced as reason so operators can diagnose without grepping logs.

GET

health

Health Check

curl --request GET \
  --url https://api.example.com/health

{
  "service": "<string>",
  "version": "<string>",
  "agent_ready": true,
  "agent_name": "<string>",
  "reason": "<string>"
}

Response

200 - application/json

Successful Response

Response shape for /health.

reason is only emitted when an assembly failure handler set app.state.boot_error; the route uses response_model_exclude_unset so the field stays absent (not null) on the happy path.

status

enum<string>

required

Available options:

ok,

degraded

service

string

required

version

string

required

agent_ready

boolean

required

agent_name

string | null

required

reason

string | null

Last modified on May 22, 2026

Copilotkit Stream

Reload Config

Health Check

curl --request GET \
  --url https://api.example.com/health

{
  "service": "<string>",
  "version": "<string>",
  "agent_ready": true,
  "agent_name": "<string>",
  "reason": "<string>"
}

Documentation Index

Response