AgentsClientParameters
ElevenLabs.AgentsClient parameters. Can be passed as arguments to the ElevenLabs.createAgentsClient method.
Props
agentId
agentId: string
The unique identifier for the voice to use in the TTS process.
includeConversationId
includeConversationId: false
| undefined
| true
Optional. Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again. The default value is false.
onWebSocketClose
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
| undefined
Optional. A callback function that is called when the WebSocket connection is closed.
statistics
statistics: false
| undefined
| true
Optional. Enables statistics functionality.
trace
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.
xiApiKey
xiApiKey: string
The API key for the ElevenLabs Agents.