Deepgram

Deepgram provides a VoxEngine client for connecting a call or media unit to the Deepgram Voice Agent API over WebSocket.

Use Deepgram.createVoiceAgentClient(...) to create a VoiceAgentClient for the current scenario.

Related guides

Contents

• Usage: required module import and basic flow.
• Factory functions: create the Deepgram Voice Agent client.
• Methods: media and conversation control methods.
• Events: WebSocket media bridge events.
• VoiceAgentEvents: Deepgram Voice Agent event names and payload fields.

Usage

Add the module before using the namespace:

1
require(Modules.Deepgram);

Create the client, bridge media, and listen for Voice Agent events.

Factory functions

createVoiceAgentClient

Creates a Deepgram.VoiceAgentClient instance.

1
createVoiceAgentClient(parameters: VoiceAgentClientParameters): Promise<VoiceAgentClient>

Parameters

Returns

VoiceAgentClient

Methods

addEventListener

Adds a handler for the specified Deepgram.VoiceAgentEvents or Deepgram.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: Events | VoiceAgentEvents | string, callback: (event: object) => any): void

Parameters

Returns

clearMediaBuffer

Clears the VoiceAgent WebSocket media buffer.

1
clearMediaBuffer(parameters?: ClearMediaBufferParameters): void

Parameters

Returns

close

Closes the VoiceAgent connection (over WebSocket) or connection attempt.

1
close(): void

Parameters

This method does not accept parameters.

Returns

id

Returns the VoiceAgentClient id.

1
id(): string

Parameters

This method does not accept parameters.

Returns

removeEventListener

Removes a handler for the specified Deepgram.VoiceAgentEvents or Deepgram.Events event.

1
removeEventListener(event: Events | VoiceAgentEvents | string, callback?: (event: object) => any): void

Parameters

Returns

sendFunctionCallResponse

Send a message to provide a function call response in the middle of a conversation. https://developers.deepgram.com/reference/voice-agent/voice-agent#send.AgentV1SendFunctionCallResponse

1
sendFunctionCallResponse(input: Object): void

Parameters

Returns

sendInjectAgentMessage

Send a message to immediately trigger an Agent statement. https://developers.deepgram.com/reference/voice-agent/voice-agent#send.AgentV1InjectAgentMessage

1
sendInjectAgentMessage(input: Object): void

Parameters

Returns

sendInjectUserMessage

Send a text based message to the agent. https://developers.deepgram.com/reference/voice-agent/voice-agent#send.AgentV1InjectUserMessage

1
sendInjectUserMessage(input: Object): void

Parameters

Returns

sendMediaTo

Starts sending media from the VoiceAgent (via WebSocket) to the media unit. VoiceAgent works in real time.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

Returns

sendUpdatePrompt

Send a message to update the system prompt of the agent. https://developers.deepgram.com/reference/voice-agent/voice-agent#send.AgentV1UpdatePrompt

1
sendUpdatePrompt(input: Object): void

Parameters

Returns

sendUpdateSpeak

Send a message to change the Speak model in the middle of a conversation. https://developers.deepgram.com/reference/voice-agent/voice-agent#send.AgentV1UpdateSpeak

1
sendUpdateSpeak(input: Object): void

Parameters

Returns

stopMediaTo

Stops sending media from the VoiceAgent (via WebSocket) to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters

Returns

webSocketId

Returns the VoiceAgent WebSocket id.

1
webSocketId(): string

Parameters

This method does not accept parameters.

Returns

Events

These events describe audio received through the Deepgram WebSocket media bridge.

WebSocketMediaStarted

Triggered when the audio stream sent by a third party through a Deepgram WebSocket is started playing.

Event constant: Events.WebSocketMediaStarted

Payload

WebSocketMediaEnded

Triggers after the end of the audio stream sent by a third party through a Deepgram WebSocket (1 second of silence).

Event constant: Events.WebSocketMediaEnded

Payload

VoiceAgentEvents

These events mirror server messages from the Deepgram Voice Agent API. The data field contains the provider event payload.

1
{
2
  "type": "Welcome"
3
}

1
{
2
  "type": "SettingsApplied"
3
}

1
{
2
  "type": "ConversationText"
3
}

1
{
2
  "type": "UserStartedSpeaking"
3
}

1
{
2
  "type": "AgentThinking"
3
}

1
{
2
  "type": "FunctionCallRequest"
3
}

1
{
2
  "type": "PromptUpdated"
3
}

1
{
2
  "type": "SpeakUpdated"
3
}

1
{
2
  "type": "AgentAudioDone"
3
}

1
{
2
  "type": "Error"
3
}

1
{
2
  "type": "Warning"
3
}

1
{
2
  "type": "History"
3
}