Skip to main content

​
Health Check

Check the health status of the Shinzo Platform API. These endpoints do not require authentication and can be used to verify connectivity.

​
Basic Health Check

Fast health check endpoint with cached database status.

​
Endpoint

GET /health

​
Authentication

No authentication required.

​
Example Request

curl -X GET https://api.app.shinzo.ai/health

​
Response

{
  "status": "healthy",
  "database": "healthy"
}

​
Status Codes

CodeDescription
200Service is healthy
503Service is unhealthy

​
Deep Health Check

Comprehensive health check that queries the database and reports latency metrics.

​
Endpoint

GET /health/deep

​
Authentication

No authentication required.

​
Example Request

curl -X GET https://api.app.shinzo.ai/health/deep

​
Response

{
  "status": "healthy",
  "database": {
    "status": "healthy",
    "latency_ms": 5
  },
  "timestamp": "2025-01-20T14:30:00Z"
}

​
Response Fields

FieldTypeDescription
statusstringOverall health status (healthy, degraded, unhealthy)
database.statusstringDatabase connection status
database.latency_msnumberDatabase query latency in milliseconds
timestampstringHealth check timestamp (ISO 8601)

​
Status Codes

CodeDescription
200Service is healthy
503Service is unhealthy

​
Use Cases

  • Load balancer health checks: Use /health for fast checks
  • Monitoring and alerting: Use /health/deep for detailed status
  • Connectivity verification: Use either endpoint to verify API reachability