Rate this page:

VoiceAgentAPIClientParameters

Grok.VoiceAgentAPIClient parameters. Can be passed as arguments to the Grok.createVoiceAgentAPIClient method.

Props

onWebSocketClose: (event: WebSocketEvents.CLOSE) => void | undefined

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

statistics: false | undefined | true

Optional. Enables statistics functionality.

trace: false | undefined | true

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.

xAIApiKey: string

The xAI API key for the Grok VoiceAgent API.