Health API

A public liveness probe. This is the only endpoint that does not require authentication.

GET/v1/health

Authentication

None. This endpoint is public and accepts no API key.

Example request

bash
curl https://api.carrieros.ai/v1/health

Response

FieldTypeDescription
statusstringhealthy when the service is up.
versionstringAPI surface version (v1).
timestampstringCurrent server time (ISO).
uptimenumberProcess uptime in seconds.
environmentstringServer environment.

Example response

json
{
  "success": true,
  "data": {
    "status": "healthy",
    "version": "v1",
    "timestamp": "2026-07-27T10:00:00.000Z",
    "uptime": 3600,
    "environment": "production"
  }
}