Realtime readiness

Read the readiness response#

GET /v1/realtime/health reports configuration readiness; it is not an active upstream-provider probe. The top-level status describes customer traffic admission: ready means the customer API can mint sessions, degraded means only the browser preview is available, and unavailable means realtime sessions cannot be established.

Gate only the features you use#

For a browser voice agent that calls customer tools, gate only on the fields that path requires:

const health = await ox.realtime.health.retrieve();

if (!health.customer_api_ready ||
    !health.capabilities.voice_agent ||
    !health.capabilities.customer_tools) {
  throw new Error(health.summary);
}

Understand limitations#

Missing optional features appear in limitations. In particular, durable_state_unavailable disables server-persisted agent configuration, durable session records, and control-plane quotas; it does not disable browser-configured voice, customer tools, or core realtime traffic. Require durable_state or capabilities.server_persisted_agent_configuration only when your application uses those features.