realtime

Open a realtime session

Changed on

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/v1/realtime

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/realtime
  • Auth
    HTTP bearer

Query parameters

modelstring

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

providerstring

Optional provider hint

call_idstring

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

Changes

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status

    • warning

      added the new permission_error enum value to the / response property for the response status