Skip to main content
GET
/
api
/
v1
/
ai
/
health
AI service health
curl --request GET \
  --url https://handauncle-backend-prod-205012263523.asia-south1.run.app/api/v1/ai/health
{
  "data": {
    "service": "ai",
    "provider": "<string>",
    "model": "<string>",
    "streamingSupport": true,
    "streamingHeader": "<string>",
    "ragEnabled": true,
    "authMethod": "<string>",
    "guest_chat_enabled": true,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.handauncle.com/llms.txt

Use this file to discover all available pages before exploring further.

Lightweight heartbeat for the AI router. Returns the active provider/model plus capabilities that the chat endpoint currently exposes.

​
Response fields

  • data.service: Always ai.
  • data.status: healthy, degraded, or unhealthy.
  • data.provider: Which LLM vendor is active (openai, anthropic, or multi).
  • data.model: Default model returned by aiConfig.getDefaultModel().
  • data.streaming_support: true once SSE streaming is available.
  • data.streaming_header: Header key (X-Stream-Response or Stream) clients should set to enable streaming.
  • data.rag_enabled: Whether retrieval augmented generation is active.
  • data.auth_method: Describes the accepted auth inputs (Auth0 JWT or device headers).
  • data.guest_chat_enabled: Indicates whether unauthenticated guests can chat.
  • data.timestamp: ISO 8601 server time.

​
Example request

curl https://api.handauncle.com/api/v1/ai/health

​
Example response

{
  "success": true,
  "data": {
    "service": "ai",
    "status": "healthy",
    "provider": "openai",
    "model": "gpt-4o-mini",
    "streaming_support": true,
    "streaming_header": "X-Stream-Response or Stream",
    "rag_enabled": true,
    "auth_method": "Auth0 JWT (RS256) OR Device Headers",
    "guest_chat_enabled": true,
    "timestamp": "2025-12-01T12:00:00.000Z"
  },
  "meta": {
    "timestamp": "2025-12-01T12:00:00.000Z",
    "request_id": "req_abc"
  }
}

Response

Service heartbeat

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
meta
object
required