v1

latestOpenAPI 3.1.0MIT License2026-07-17121547.4 KB

Real-time Communication

WebSocket

Realtime Status

Get Realtime Service Status

Get the current status of the realtime communication service.

Returns information about:
- Service availability and health
- Supported protocols and features
- Active connection counts
- WebSocket endpoint configurations

get/api/v1/realtime/status

Response

Service status retrieved successfully

status'available' | 'degraded' | 'unavailable' required

Current service status

websocket_endpointsobject required

Available WebSocket endpoints

featuresobject required

Supported features and capabilities

active_connectionsobject required

Current active connection counts

protocols_supportedstring[]

Supported communication protocols

versionstring

API version

Example response

{
  "status": "available",
  "websocket_endpoints": {
    "conversation": "/api/v1/realtime/conversation",
    "dashboard_relay": "/api/v1/realtime/dashboard/relay"
  },
  "features": {
    "conversation_streaming": true,
    "dashboard_broadcasting": true,
    "orchestrator_support": true,
    "session_management": true
  },
  "active_connections": {
    "conversation_sessions": 0,
    "dashboard_clients": 0
  },
  "protocols_supported": [
    "WebSocket"
  ],
  "version": "v1"
}