1. Guides
  2. Calls
  3. Voicemail and beep detection
Rate this page:

RealtimeAPIClientParameters

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

Props

apiKey

Copy URL

The API key for the OpenAI Realtime API.

model

Optional
Copy URL

Optional. The model to use for OpenAI Realtime API processing. The default value is gpt-realtime.

onWebSocketClose

Optional
Copy URL

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

statistics

Optional
Copy URL

Optional. Enables statistics functionality.

trace

Optional
Copy URL

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.

type

Optional
Copy URL

Optional. The type of the client. The default value is OpenAI.RealtimeAPIClientType.REALTIME.