Skip to content

RealtimeSessionConnectOptions

type RealtimeSessionConnectOptions = object;

Properties

Section titled “Properties”

apiKey

Section titled “apiKey”
apiKey: string | (() => string | Promise<string>);

The API key to use for the connection. Pass a function to lazily load the API key. Overrides default client options.

callId?

Section titled “callId?”
optional callId?: string;

The call ID to attach to when connecting to a SIP-initiated session.

model?

Section titled “model?”
optional model?:
  | OpenAIRealtimeModels
  | string & object;

The model to use for the connection.

url?

Section titled “url?”
optional url?: string;

The URL to use for the connection.