RealtimeAPIClientParameters

OpenAI.Beta.RealtimeAPIClient parameters. Can be passed as arguments to the OpenAI.Beta.createRealtimeAPIClient method.

Props

public  apiKey

The API key for the OpenAI Realtime API.

public  model

Optional. The model to use for OpenAI Realtime API processing. The default value is gpt-4o-realtime-preview-2024-10-01.

public  onWebSocketClose

Optional. A callback function that is called when the WebSocket connection is closed.

public  statistics

Optional. Enables statistics functionality.

public  trace

Optional. Whether to enable the tracing functionality. If tracing is enabled, an URL to the trace file appears in the websocket.created message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

Note: Enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.