Try Bifrost Enterprise free for 14 days. Explore now
A valid request URL is required to generate request examplesRealtime API WebSocket
Opens a bidirectional WebSocket session to a realtime-capable provider (e.g. OpenAI Realtime, Azure Realtime preview). Bifrost proxies the upstream socket and applies governance, observability, and key selection on connect.
The target model is provided via the model query parameter (or deployment
for Azure-style routes). The OpenAI SDK sends the API key over the
openai-insecure-api-key.<key> WebSocket subprotocol; Bifrost extracts it and
treats it the same as a Bearer header.
Inference auth applies — Bearer/Basic/Virtual Key/API Key headers are all accepted, plus the subprotocol form above.
A valid request URL is required to generate request examplesDocumentation Index
Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer token authentication. Use your provider API key or Bifrost authentication token.
Virtual keys (prefixed with sk-bf-) can also be passed here.
Headers
Must be websocket
websocket Optional WebSocket subprotocol. Use openai-insecure-api-key.<key> to
authenticate when headers cannot be supplied by the client.
Query Parameters
Provider model identifier in provider/model form (e.g. openai/gpt-4o-realtime-preview).
Either model or deployment must be supplied; requests with neither (or both) are rejected with HTTP 400 before the WebSocket upgrade completes.
Azure deployment name (for Azure-style routes).
Response
Switching Protocols — WebSocket upgrade succeeded
Was this page helpful?