Rate this page:

AgentsClientParameters

ElevenLabs.AgentsClient parameters. Can be passed as arguments to the ElevenLabs.createAgentsClient method.

Props

agentId

Copy URL
agentId: 

string

The unique identifier for the voice to use in the TTS process.

includeConversationId

Copy URL
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

Copy URL
onWebSocketClose: 

(event: WebSocketEvents.CLOSE) => void

|

undefined

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

statistics

Copy URL
statistics: 

false

|

undefined

|

true

Optional. Enables statistics functionality.

trace

Copy URL
trace: 

false

|

undefined

|

true

Optional. Enables trace functionality.

xiApiKey

Copy URL
xiApiKey: 

string

The API key for the ElevenLabs Agents.