v1

latestOpenAPI 3.1.0MIT License2026-07-17121547.4 KB

health

Health

Comprehensive Readiness Check

Comprehensive readiness probe that checks all critical dependencies with timeouts.

This endpoint verifies:
- Redis connectivity and performance
- Azure OpenAI client health
- Speech services (TTS/STT) availability
- ACS caller configuration and connectivity
- RT Agents initialization
- Authentication configuration (when ENABLE_AUTH_VALIDATION=True)
- Event system health

When authentication validation is enabled, checks:
- BACKEND_AUTH_CLIENT_ID is set and is a valid GUID
- AZURE_TENANT_ID is set and is a valid GUID  
- ALLOWED_CLIENT_IDS contains at least one valid GUID

Returns 503 if any critical services are unhealthy, 200 if all systems are ready.

get/api/v1/readiness

Response

All services are ready

status'ready' | 'not_ready' | 'degraded' required

Overall readiness status

timestampnumber required

Timestamp when check was performed

response_time_msnumber required

Total time taken for all checks in milliseconds

event_systemobject nullable

Event system status information

Example response

{
  "checks": [
    {
      "check_time_ms": 12.5,
      "component": "redis",
      "details": "Connected to Redis successfully",
      "status": "healthy"
    },
    {
      "check_time_ms": 8.3,
      "component": "azure_openai",
      "details": "Client initialized",
      "status": "healthy"
    }
  ],
  "event_system": {
    "domains_count": 2,
    "handlers_count": 7,
    "is_healthy": true
  },
  "response_time_ms": 45.2,
  "status": "ready",
  "timestamp": 1691668800
}