Health Check Endpoint¶
Check service status, loaded models, and dependency health.
In plain terms
Use this endpoint to verify the API is up and ready to accept requests. It returns the service status, API version, and whether database and Redis are healthy. No authentication required. Ideal for monitoring dashboards and uptime checks.
GET
/health Base URL¶
Response Fields¶
| Field | Type | Description |
|---|---|---|
status | string | Service health status ("healthy") |
version | string | API version (e.g., "2.0.0") |
environment | string | "production" or "development" |
models_loaded | array | List of loaded model identifiers (e.g. mixed-10-v2, mixed-30-v2, mixed-60-v2, mixed-90-v2, mixed-120-v2; varies by deployment) |
dependencies | object | Status of external dependencies |
Example¶
Request¶
Response¶
All responses are wrapped in the standard envelope.
{
"data": {
"status": "healthy",
"version": "2.0.0",
"environment": "production",
"models_loaded": ["10", "50", "250", "mixed-10-v2", "mixed-30-v2", "mixed-60-v2", "mixed-90-v2", "mixed-120-v2"],
"dependencies": {
"database": "ok",
"redis": "ok"
}
},
"success": true,
"message": "OK"
}
Usage¶
Use this endpoint to verify the API is operational before making liveness detection requests. This is useful for monitoring and health checks in your infrastructure.
For real-time system status and incident updates, visit our Status Page.