For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Ask AIPlaygroundLoginFree API Key
HomeAPI ReferenceVoice AgentSpeech-to-TextText-to-SpeechIntelligenceSelf-Hosted Deployments
HomeAPI ReferenceVoice AgentSpeech-to-TextText-to-SpeechIntelligenceSelf-Hosted Deployments
  • Get Started
    • Overview
    • Build a Voice Agent
    • Feature Overview
    • Template Apps
  • Configure
    • Overview
    • STT Models
    • LLM Models
    • TTS Models
    • Media Inputs & Outputs
    • Prompting Voice Agents
    • Multilingual Voice Agents
    • Maintaining Context
    • Reusable Agent Configurations
  • Build
    • Multi-Agent Architecture
  • Connect
  • Controls
      • Overview
      • Settings
      • Update Speak
      • Update Think
      • Update Prompt
      • Inject Agent
      • Inject User
      • Agent Keep Alive
  • Optimize
    • Voice Agent TTS Controls
    • Message Flow
    • Audio & Playback
    • Audio Preprocessing & Barge-In
    • Adaptive Echo Cancellation
  • Resources
    • SDKs
    • UI Components
    • API Reference
LogoLogo
Ask AIPlaygroundLoginFree API Key
On this page
  • Purpose
  • Example Payloads
ControlsInputs: Client Messages

Update Speak

Send a message to change the Speak model in the middle of a conversation.
Was this page helpful?
Previous

Update Think

Send a message to replace the Think provider in the middle of a conversation.
Next
Built with
Voice Agent

The UpdateSpeak message is a JSON message that you can use to change the Speak model in the middle of a conversation.

Purpose

The UpdateSpeak message is a JSON message that allows you to switch the Speak model during a conversation. This flexibility enables real-time adjustments to the agent’s voice output, ensuring a more dynamic and responsive interaction tailored to the evolving needs of the conversation.

Example Payloads

To send the UpdateSpeak message, you need to send the following JSON message to the server:

JSON
1{
2 "type": "UpdateSpeak",
3 "speak": {
4 "provider": {
5 "type": "deepgram",
6 "model": "aura-2-thalia-en"
7 }
8 }
9}

Upon receiving the UpdateSpeak message, the server will process all remaining audio data and return a SpeakUpdated message.

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