Skip to main content
Deepgram's Docs

Search documentation

Type to search this documentation.

On this pageOverview

Inputs: Client Messages

Client Messages are JSON-formatted commands that the client sends to the Deepgram server over the WebSocket connection during a voice agent interaction. These messages allow the client to control various aspects of the conversation, configure the agent, and provide necessary information.

  • Settings: Initializes the voice agent, sets up audio transmission formats, and optionally provides conversation history context before any voice data is exchanged.
  • Update Listen: Updates the Listen configuration on the fly — adjust EOT thresholds, keyterms, and language hints without restarting the session.
  • Update Think: Replaces the entire Think provider configuration, including the model, prompt, endpoint, and functions.
  • Update Speak: Enables changing the Speak model during the conversation.
  • Inject Agent Message: Triggers an immediate statement from the agent.
  • Inject User Message: Sends a text-based message to the agent as if the user had spoken it.
  • Update Prompt: Updates the system prompt of the agent during the conversation.
  • Force End Turn: Ends the current user turn immediately. Requires a Deepgram V2 (Flux) listen provider.
  • Function Call Response: Sends the result of a function call back to the server.
  • Agent Keep Alive: Maintains the connection to prevent timeouts.

For more detailed information on the format and usage of each message, refer to the individual documentation pages for each message.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu