VoiceAgentRealtimeClient class

Client for establishing realtime sessions with managed Foundry voice agents.

Methods

connect(string, VoiceAgentRealtimeClientConnectOptions)

Establishes a WebSocket connection to a managed voice agent.

Constructor Details

VoiceAgentRealtimeClient(string, TokenCredential, VoiceAgentRealtimeClientOptions)

new VoiceAgentRealtimeClient(endpoint: string, credential: TokenCredential, options?: VoiceAgentRealtimeClientOptions)

Parameters

endpoint

string

credential
TokenCredential

Method Details

connect(string, VoiceAgentRealtimeClientConnectOptions)

Establishes a WebSocket connection to a managed voice agent.

function connect(agentName: string, options?: VoiceAgentRealtimeClientConnectOptions): Promise<VoiceAgentConnection>

Parameters

agentName

string

Returns