Health Check

Check API availability. No authentication required. Returns 200 when healthy.

GET /v1/health

Health Check

cURL

curl --request GET \
  --url https://api.superdoc.dev/v1/health

200

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.2.3",
  "deployment": {
    "region": "us-east1",
    "environment": "production"
  }
}

Response

200 - application/json

Service is healthy

status · enum<string> · required

Available options: healthy

timestamp · string<date-time> · required

version · string · required

deployment · object

Show child attributes

instance · object

Show child attributes