WebSocket Realtime (OpenAI alias)

OpenAI-prefixed alias of GET /v1/realtime. WebSocket upgrade endpoint for OpenAI Realtime; selects the model via the model query parameter (Azure GA) or deployment (preview).

GET
/openai/v1/realtime
AuthorizationBearer <token>

Bearer token authentication. Use your MPilot virtual-key JWT or admin JWT. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

Query Parameters

model?string
deployment?string

Header Parameters

Upgradestring
Value in"websocket"
Sec-WebSocket-Protocol?string

Response Body

curl -X GET "https://loading/{AI_GATEWAY_URL}/openai/v1/realtime?model=string&deployment=string" \  -H "Upgrade: websocket" \  -H "Sec-WebSocket-Protocol: string"
Empty
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
Empty
On this page

On this page

No Headings