Build a Voice Agent
Build a Voice Agent using Deepgram's Voice Agent WebSocket
HandshakeTry it
WSS
wss://agent.deepgram.com/v1/agent/converse
Headers
Authorization
API key for authentication. Format should be be either ‘token <DEEPGRAM_API_KEY>’ or ‘Bearer <JWT_TOKEN>’
Send
sendSettings
Send settings configuration to Deepgram's Voice Agent API
OR
sendUpdateSpeak
Send update speak to Deepgram's Voice Agent API
OR
sendInjectUserMessage
Send inject user message to Deepgram's Voice Agent API
OR
sendInjectAgentMessage
Send inject agent message to Deepgram's Voice Agent API
OR
sendFunctionCallResponse
Send a function call response from the client to the server after executing a requested function
OR
sendKeepAlive
Send keep alive to Deepgram's Voice Agent API
OR
sendPromptUpdate
Send a prompt update to Deepgram's Voice Agent API
Receive
receiveFunctionCallResponse
Receive a function call response from the server containing information about an agent-initiated function call
OR
receivePromptUpdate
Receive prompt update from Deepgram's Voice Agent API
OR
receiveSpeakUpdate
Receive speak update from Deepgram's Voice Agent API
OR
receiveInjectionRefused
Receive injection refused message from Deepgram's Voice Agent API
OR
receiveWelcome
Receive welcome message from Deepgram's Voice Agent API
OR
receiveSettingsApplied
Receive settings applied message from Deepgram's Voice Agent API
OR
receiveConversationText
Receive conversation text from Deepgram's Voice Agent API
OR
receiveUserStartedSpeaking
Receive user started speaking message from Deepgram's Voice Agent API
OR
receiveAgentThinking
Receive agent thinking message from Deepgram's Voice Agent API
OR
receiveFunctionCallRequest
Receive function call request from Deepgram's Voice Agent API
OR
receiveAgentStartedSpeaking
Receive agent started speaking message from Deepgram's Voice Agent API
OR
receiveAgentAudioDone
Receive agent audio done message from Deepgram's Voice Agent API
OR
receiveError
Receive error response from Deepgram's Voice Agent API
OR
receiveAgentWarning
Receive warning messages from Deepgram's Voice Agent API