v1

latestOpenAPI 3.1.0MIT License2026-07-17121547.4 KB
health
Health

Basic Health Check

Basic health check endpoint that returns 200 if the server is running. Used by load balancers for liveness checks.

get/api/v1/health

Response

Service is healthy and running

statusstring required

Overall health status

versionstring

API version

timestampnumber required

Timestamp when check was performed

messagestring required

Human-readable status message

detailsobject

Additional health details

active_sessionsinteger nullable

Current number of active realtime conversation sessions (None if unavailable)

session_metricsobject nullable

Optional granular session metrics (connected/disconnected, etc.)

Example response

{
  "active_sessions": 3,
  "details": {
    "api_version": "v1",
    "service": "rtagent-backend"
  },
  "message": "Real-Time Audio Agent API v1 is running",
  "session_metrics": {
    "active": 3,
    "connected": 5,
    "disconnected": 2
  },
  "status": "healthy",
  "timestamp": 1691668800,
  "version": "1.0.0"
}
All 12 operations