Open a realtime session

Upgrades to a websocket and relays an OpenAI-compatible realtime (speech-to-speech) session to the provider that owns the model named in the ?model= query parameter. Provider credentials are injected by the gateway. Passing ?call_id= instead attaches to an existing WebRTC/SIP call as a sideband channel; calls created through this gateway instance are routed automatically, others need explicit model (and provider) parameters.

GET {base_url}/v1/realtime

Error

A valid request URL is required to generate request examples

101

"<string>"

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

model · string

Model that owns the realtime session (required unless call_id names a call created through this gateway instance)

provider · string

Optional provider hint

call_id · string

Existing WebRTC/SIP call to attach to as a sideband channel

Response

101

*/*

Switching Protocols

The response is of type string.