The AIUI health API provides endpoints to monitor server and provider health status.
The following status values are used throughout the health API:
| Status | Meaning | Color Code |
|--------|---------|------------|
| "ok" | Service is functioning normally | Green |
"ok"
| "healthy" | Service is functioning normally (legacy) | Green |
"healthy"
| "degraded" | Service is partially functional | Yellow |
"degraded"
| "error" | Service has errors | Red |
"error"
| "unknown" | Status cannot be determined | Yellow |
"unknown"
> Note: Both "ok" and "healthy" indicate successful operation. The system accepts either value for backward compatibility.
Returns the overall server health status.
Response:
Returns information about the active AI provider.
Returns detailed JSON health information from the provider gateway. Always
responds with Content-Type: application/json. The base fields from the
Content-Type: application/json
provider's health() payload are merged with the normalised fields below.
health()
| Field | Type | Description |
|-------|------|-------------|
| status | string | One of the health status values above. |
status
| type | string | Provider type (from provider field, falls back to class name). |
type
provider
| agents | integer | Count of agents reported by the provider. |
agents
| detail | string | Human-readable detail; "ok" for healthy providers. |
detail
> Note: Any unmatched /api/* path returns a JSON 404 (never the SPA
/api/*
404
> HTML shell), so API clients can rely on parsing the response body.
Check server health status:
The command displays:
Run comprehensive diagnostics:
The doctor command checks:
1. Server Health
2. Provider Status
3. Gateway Status
4. Features Loaded
5. Config Store
6. Datastore
7. Channels
Check provider health:
The dashboard automatically accepts both "ok" and "healthy" as success statuses: