System API reference
Service status.
Service health
GET /health
No authentication.
Reports whether the API and its dependencies are healthy. No authentication.
Credits. Free: no credits.
Responses
200 All dependencies are healthy.
Schema HealthReport (application/json).
Headers: X-Request-Id
{
"status": "healthy",
"version": "string",
"commit": "string",
"checks": {
"database": "up",
"redis": "up"
}
} 503 A dependency is down (SERVICE_UNAVAILABLE; details holds the report).
Schema ErrorEnvelope (application/json).
Headers: X-Request-Id
default Error (see ErrorEnvelope and /v1/docs/errors).
Schema ErrorEnvelope (application/json).
Headers: X-Request-Id
Public service status
GET /status
No authentication.
Coarse state of the API, the generation pipeline and the image and vision models over the last 15 minutes. Always 200, cached for 30 s, readable from any origin. No authentication. A model with too little recent traffic is unknown; the top-level status is the worst known component.
Credits. Free: no credits.
Responses
200 The current status.
Schema StatusReport (application/json).
Headers: X-Request-Id , Cache-Control
{
"status": "operational",
"updatedAt": "2026-10-29T12:00:00.000Z",
"windowSeconds": 900,
"components": [
{
"id": "api",
"name": "Generation pipeline",
"status": "operational"
}
]
} default Error (see ErrorEnvelope and /v1/docs/errors).
Schema ErrorEnvelope (application/json).
Headers: X-Request-Id