```
public final class ConversationConfig

                    
```
Configuration class for conversation sessions
This class defines the parameters needed to start a conversation with an ElevenLabs agent. Exactly one of agentId, conversationToken, or signedUrl must be provided.
Public Agents (no authentication required):
- Use agentId only — works in both voice and text-only mode.
- SDK fetches the per-session token from the public endpoint.
Private Agents — voice (LiveKit/WebRTC):
- Use conversationToken, generated on your backend with your API key.
Private Agents — text-only (raw WebSocket):
- Use signedUrl, returned by your backend's call to /v1/convai/conversation/get-signed-url. The SDK opens it verbatim.

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`isPrivateAgent`
`private final String`	`agentId`
`private final String`	`conversationToken`
`private final String`	`signedUrl`
`private final String`	`userId`
`private final Boolean`	`textOnly`
`private final Integer`	`audioInputSampleRate`
`private final String`	`apiEndpoint`
`private final String`	`websocketUrl`
`private final String`	`environment`
`private final Overrides`	`overrides`
`private final Map<String, Object>`	`customLlmExtraBody`
`private final Map<String, Object>`	`dynamicVariables`
`private final Map<String, ClientTool>`	`clientTools`
`private final Function1<String, Unit>`	`onConnect`
`private final Function2<String, String, Unit>`	`onMessage`
`private final Function1<ConversationMode, Unit>`	`onModeChange`
`private final Function1<ConversationStatus, Unit>`	`onStatusChange`
`private final Function1<Boolean, Unit>`	`onCanSendFeedbackChange`
`private final Function1<ConversationEvent.ClientToolCall, Unit>`	`onUnhandledClientToolCall`
`private final Function1<Float, Unit>`	`onVadScore`
`private final Function1<Float, Unit>`	`onAudioLevelChanged`
`private final Function1<AudioFrame, Unit>`	`onAudioFrame`
`private final Function1<Map<String, Object>, Unit>`	`onAudioAlignment`
`private final Function1<Map<String, Object>, Unit>`	`onAgentResponseMetadata`
`private final Function1<String, Unit>`	`onUserTranscript`
`private final Function1<String, Unit>`	`onAgentResponse`
`private final Function2<String, String, Unit>`	`onAgentResponseCorrection`
`private final Function2<String, Integer, Unit>`	`onUserTranscriptEvent`
`private final Function2<String, Integer, Unit>`	`onTentativeUserTranscriptEvent`
`private final Function2<String, Integer, Unit>`	`onAgentResponseEvent`
`private final Function3<AgentResponsePartType, String, Integer, Unit>`	`onAgentResponsePartEvent`
`private final Function2<String, Integer, Unit>`	`onAgentResponseCorrectionEvent`
`private final Function4<String, String, String, Boolean, Unit>`	`onAgentToolResponse`
`private final Function3<String, String, String, Unit>`	`onConversationInitiationMetadata`
`private final Function1<Integer, Unit>`	`onInterruption`
`private final Function1<DisconnectionDetails, Unit>`	`onDisconnect`
`private final Function2<Integer, String, Unit>`	`onError`
`private final AudioPipelineConfiguration`	`audioConfiguration`
`private final Boolean`	`useMediaStream`

Constructor Summary

Constructors
Constructor	Description
ConversationConfig(String agentId, String conversationToken, String signedUrl, String userId, Boolean textOnly, Integer audioInputSampleRate, String apiEndpoint, String websocketUrl, String environment, Overrides overrides, Map<String, Object> customLlmExtraBody, Map<String, Object> dynamicVariables, Map<String, ClientTool> clientTools, Function1<String, Unit> onConnect, Function2<String, String, Unit> onMessage, Function1<ConversationMode, Unit> onModeChange, Function1<ConversationStatus, Unit> onStatusChange, Function1<Boolean, Unit> onCanSendFeedbackChange, Function1<ConversationEvent.ClientToolCall, Unit> onUnhandledClientToolCall, Function1<Float, Unit> onVadScore, Function1<Float, Unit> onAudioLevelChanged, Function1<AudioFrame, Unit> onAudioFrame, Function1<Map<String, Object>, Unit> onAudioAlignment, Function1<Map<String, Object>, Unit> onAgentResponseMetadata, Function1<String, Unit> onUserTranscript, Function1<String, Unit> onAgentResponse, Function2<String, String, Unit> onAgentResponseCorrection, Function2<String, Integer, Unit> onUserTranscriptEvent, Function2<String, Integer, Unit> onTentativeUserTranscriptEvent, Function2<String, Integer, Unit> onAgentResponseEvent, Function3<AgentResponsePartType, String, Integer, Unit> onAgentResponsePartEvent, Function2<String, Integer, Unit> onAgentResponseCorrectionEvent, Function4<String, String, String, Boolean, Unit> onAgentToolResponse, Function3<String, String, String, Unit> onConversationInitiationMetadata, Function1<Integer, Unit> onInterruption, Function1<DisconnectionDetails, Unit> onDisconnect, Function2<Integer, String, Unit> onError, AudioPipelineConfiguration audioConfiguration, Boolean useMediaStream)

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsPrivateAgent()`
`final String`	`getAgentId()`
`final String`	`getConversationToken()`
`final String`	`getSignedUrl()`
`final String`	`getUserId()`
`final Boolean`	`getTextOnly()`
`final Integer`	`getAudioInputSampleRate()`
`final String`	`getApiEndpoint()`
`final String`	`getWebsocketUrl()`
`final String`	`getEnvironment()`
`final Overrides`	`getOverrides()`
`final Map<String, Object>`	`getCustomLlmExtraBody()`
`final Map<String, Object>`	`getDynamicVariables()`
`final Map<String, ClientTool>`	`getClientTools()`
`final Function1<String, Unit>`	`getOnConnect()`
`final Function2<String, String, Unit>`	`getOnMessage()`
`final Function1<ConversationMode, Unit>`	`getOnModeChange()`
`final Function1<ConversationStatus, Unit>`	`getOnStatusChange()`
`final Function1<Boolean, Unit>`	`getOnCanSendFeedbackChange()`
`final Function1<ConversationEvent.ClientToolCall, Unit>`	`getOnUnhandledClientToolCall()`
`final Function1<Float, Unit>`	`getOnVadScore()`
`final Function1<Float, Unit>`	`getOnAudioLevelChanged()`
`final Function1<AudioFrame, Unit>`	`getOnAudioFrame()`
`final Function1<Map<String, Object>, Unit>`	`getOnAudioAlignment()`
`final Function1<Map<String, Object>, Unit>`	`getOnAgentResponseMetadata()`
`final Function1<String, Unit>`	`getOnUserTranscript()`
`final Function1<String, Unit>`	`getOnAgentResponse()`
`final Function2<String, String, Unit>`	`getOnAgentResponseCorrection()`
`final Function2<String, Integer, Unit>`	`getOnUserTranscriptEvent()`
`final Function2<String, Integer, Unit>`	`getOnTentativeUserTranscriptEvent()`
`final Function2<String, Integer, Unit>`	`getOnAgentResponseEvent()`
`final Function3<AgentResponsePartType, String, Integer, Unit>`	`getOnAgentResponsePartEvent()`
`final Function2<String, Integer, Unit>`	`getOnAgentResponseCorrectionEvent()`
`final Function4<String, String, String, Boolean, Unit>`	`getOnAgentToolResponse()`
`final Function3<String, String, String, Unit>`	`getOnConversationInitiationMetadata()`
`final Function1<Integer, Unit>`	`getOnInterruption()`
`final Function1<DisconnectionDetails, Unit>`	`getOnDisconnect()`
`final Function2<Integer, String, Unit>`	`getOnError()`
`final AudioPipelineConfiguration`	`getAudioConfiguration()`
`final Boolean`	`getUseMediaStream()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConversationConfig

ConversationConfig(String agentId, String conversationToken, String signedUrl, String userId, Boolean textOnly, Integer audioInputSampleRate, String apiEndpoint, String websocketUrl, String environment, Overrides overrides, Map<String, Object> customLlmExtraBody, Map<String, Object> dynamicVariables, Map<String, ClientTool> clientTools, Function1<String, Unit> onConnect, Function2<String, String, Unit> onMessage, Function1<ConversationMode, Unit> onModeChange, Function1<ConversationStatus, Unit> onStatusChange, Function1<Boolean, Unit> onCanSendFeedbackChange, Function1<ConversationEvent.ClientToolCall, Unit> onUnhandledClientToolCall, Function1<Float, Unit> onVadScore, Function1<Float, Unit> onAudioLevelChanged, Function1<AudioFrame, Unit> onAudioFrame, Function1<Map<String, Object>, Unit> onAudioAlignment, Function1<Map<String, Object>, Unit> onAgentResponseMetadata, Function1<String, Unit> onUserTranscript, Function1<String, Unit> onAgentResponse, Function2<String, String, Unit> onAgentResponseCorrection, Function2<String, Integer, Unit> onUserTranscriptEvent, Function2<String, Integer, Unit> onTentativeUserTranscriptEvent, Function2<String, Integer, Unit> onAgentResponseEvent, Function3<AgentResponsePartType, String, Integer, Unit> onAgentResponsePartEvent, Function2<String, Integer, Unit> onAgentResponseCorrectionEvent, Function4<String, String, String, Boolean, Unit> onAgentToolResponse, Function3<String, String, String, Unit> onConversationInitiationMetadata, Function1<Integer, Unit> onInterruption, Function1<DisconnectionDetails, Unit> onDisconnect, Function2<Integer, String, Unit> onError, AudioPipelineConfiguration audioConfiguration, Boolean useMediaStream)

Parameters:: agentId - Agent identifier for public agents; conversationToken - Pre-generated WebRTC token for private voice agents; signedUrl - Pre-signed WebSocket URL for private text-only agents; userId - Optional user identifier for conversation tracking; textOnly - Whether to use text-only mode (true) or voice mode (false, default); audioInputSampleRate - Sample rate for audio recording in Hz (default: 48000 for high quality); apiEndpoint - Base URL for ElevenLabs API (default: "https://api.elevenlabs.; websocketUrl - WebSocket URL for LiveKit WebRTC connection (default: "wss://livekit.rtc.elevenlabs.; environment - Optional environment name for the agent (defaults to "production" on the server); audioConfiguration - Optional microphone pipeline settings (software mute, muted-speech callbacks)

Method Detail

getIsPrivateAgent
```
 final Boolean getIsPrivateAgent()
```

getAgentId
```
 final String getAgentId()
```

getConversationToken
```
 final String getConversationToken()
```

getSignedUrl
```
 final String getSignedUrl()
```

getUserId
```
 final String getUserId()
```

getTextOnly
```
 final Boolean getTextOnly()
```

getAudioInputSampleRate

 final Integer getAudioInputSampleRate()

getApiEndpoint
```
 final String getApiEndpoint()
```

getWebsocketUrl
```
 final String getWebsocketUrl()
```

getEnvironment
```
 final String getEnvironment()
```

getOverrides
```
 final Overrides getOverrides()
```

getCustomLlmExtraBody

 final Map<String, Object> getCustomLlmExtraBody()

getDynamicVariables

 final Map<String, Object> getDynamicVariables()

getClientTools

 final Map<String, ClientTool> getClientTools()

getOnConnect

 final Function1<String, Unit> getOnConnect()

getOnMessage

 final Function2<String, String, Unit> getOnMessage()

getOnModeChange

 final Function1<ConversationMode, Unit> getOnModeChange()

getOnStatusChange

 final Function1<ConversationStatus, Unit> getOnStatusChange()

getOnCanSendFeedbackChange

 final Function1<Boolean, Unit> getOnCanSendFeedbackChange()

getOnUnhandledClientToolCall

 final Function1<ConversationEvent.ClientToolCall, Unit> getOnUnhandledClientToolCall()

getOnVadScore

 final Function1<Float, Unit> getOnVadScore()

getOnAudioLevelChanged

 final Function1<Float, Unit> getOnAudioLevelChanged()

getOnAudioFrame

 final Function1<AudioFrame, Unit> getOnAudioFrame()

getOnAudioAlignment

 final Function1<Map<String, Object>, Unit> getOnAudioAlignment()

getOnAgentResponseMetadata

 final Function1<Map<String, Object>, Unit> getOnAgentResponseMetadata()

getOnUserTranscript

 final Function1<String, Unit> getOnUserTranscript()

getOnAgentResponse

 final Function1<String, Unit> getOnAgentResponse()

getOnAgentResponseCorrection

 final Function2<String, String, Unit> getOnAgentResponseCorrection()

getOnUserTranscriptEvent

 final Function2<String, Integer, Unit> getOnUserTranscriptEvent()

getOnTentativeUserTranscriptEvent

 final Function2<String, Integer, Unit> getOnTentativeUserTranscriptEvent()

getOnAgentResponseEvent

 final Function2<String, Integer, Unit> getOnAgentResponseEvent()

getOnAgentResponsePartEvent

 final Function3<AgentResponsePartType, String, Integer, Unit> getOnAgentResponsePartEvent()

getOnAgentResponseCorrectionEvent

 final Function2<String, Integer, Unit> getOnAgentResponseCorrectionEvent()

getOnAgentToolResponse

 final Function4<String, String, String, Boolean, Unit> getOnAgentToolResponse()

getOnConversationInitiationMetadata

 final Function3<String, String, String, Unit> getOnConversationInitiationMetadata()

getOnInterruption

 final Function1<Integer, Unit> getOnInterruption()

getOnDisconnect

 final Function1<DisconnectionDetails, Unit> getOnDisconnect()

getOnError

 final Function2<Integer, String, Unit> getOnError()

getAudioConfiguration

 final AudioPipelineConfiguration getAudioConfiguration()

getUseMediaStream
```
 final Boolean getUseMediaStream()
```

Class ConversationConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConversationConfig

Method Detail

getIsPrivateAgent

getAgentId

getConversationToken

getSignedUrl

getUserId

getTextOnly

getAudioInputSampleRate

getApiEndpoint

getWebsocketUrl

getEnvironment

getOverrides

getCustomLlmExtraBody

getDynamicVariables

getClientTools

getOnConnect

getOnMessage

getOnModeChange

getOnStatusChange

getOnCanSendFeedbackChange

getOnUnhandledClientToolCall

getOnVadScore

getOnAudioLevelChanged

getOnAudioFrame

getOnAudioAlignment

getOnAgentResponseMetadata

getOnUserTranscript

getOnAgentResponse

getOnAgentResponseCorrection

getOnUserTranscriptEvent

getOnTentativeUserTranscriptEvent

getOnAgentResponseEvent

getOnAgentResponsePartEvent

getOnAgentResponseCorrectionEvent

getOnAgentToolResponse

getOnConversationInitiationMetadata

getOnInterruption

getOnDisconnect

getOnError

getAudioConfiguration

getUseMediaStream