Build a Voice Agent
Build a conversational voice agent using Deepgram's Voice Agent WebSocket
HandshakeTry it
WSS
/v1/agent/converse
Headers
Authorization
Use your API key for authentication, or alternatively generate a temporary token and pass it via the token query parameter.
Example: token %DEEPGRAM_API_KEY% or bearer %DEEPGRAM_TOKEN%
Send
AgentV1Settings
Send settings configuration to Deepgram's Voice Agent API
OR
AgentV1UpdateSpeak
Send update speak to Deepgram's Voice Agent API
OR
AgentV1InjectUserMessage
Send inject user message to Deepgram's Voice Agent API
OR
AgentV1InjectAgentMessage
Send inject agent message to Deepgram's Voice Agent API
OR
AgentV1SendFunctionCallResponse
Send a function call response from the client to the server after
executing a client-side function call. This is used when the server
requests execution of a function marked with client_side: true.
OR
AgentV1KeepAlive
Send keep alive to Deepgram's Voice Agent API
OR
AgentV1UpdatePrompt
Send a prompt update to Deepgram's Voice Agent API
OR
AgentV1Media
Send raw binary audio data to Deepgram's Voice Agent API for processing
Receive
AgentV1ReceiveFunctionCallResponse
Receive a function call response from the server after the server
has executed a server-side function call internally. This occurs
when functions are marked with client_side: false.
OR
AgentV1PromptUpdated
Receive prompt update from Deepgram's Voice Agent API
OR
AgentV1SpeakUpdated
Receive speak update from Deepgram's Voice Agent API
OR
AgentV1InjectionRefused
Receive injection refused message from Deepgram's Voice Agent API
OR
AgentV1Welcome
Receive welcome message from Deepgram's Voice Agent API
OR
AgentV1SettingsApplied
Receive settings applied message from Deepgram's Voice Agent API
OR
AgentV1ConversationText
Receive conversation text from Deepgram's Voice Agent API
OR
AgentV1UserStartedSpeaking
Receive user started speaking message from Deepgram's Voice Agent API
OR
AgentV1AgentThinking
Receive agent thinking message from Deepgram's Voice Agent API
OR
AgentV1FunctionCallRequest
Receive function call request from Deepgram's Voice Agent API
OR
AgentV1AgentStartedSpeaking
Receive agent started speaking message from Deepgram's Voice Agent API
OR
AgentV1AgentAudioDone
Receive agent audio done message from Deepgram's Voice Agent API
OR
AgentV1Error
Receive error response from Deepgram's Voice Agent API
OR
AgentV1Warning
Receive warning messages from Deepgram's Voice Agent API
OR
AgentV1Audio
Receive raw binary audio data generated by Deepgram's Voice Agent API
