SnapEditDocs
API HomeGet API Key
API Reference

Health check

Returns the health status of all SnapAPI services. No authentication required.

get/v1/health

Authorization β€” This endpoint requires an API key. Pass it in the api-key header on every request. See the quickstart

Responses

All services healthy

NameTypeDescription
statusstring
checksobject
workerstring
upstreamstring
backendstring
kvstring
timestampstring
curl -X GET "https://api.snapapi.ai/v1/health" \
  -H "api-key: YOUR_API_KEY"
Response
{
  "status": "healthy",
  "checks": {
    "worker": "ok",
    "upstream": "ok",
    "backend": "ok",
    "kv": "ok"
  },
  "timestamp": "2026-04-28T10:00:00Z"
}