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
      • Welcome
      • Settings Applied
      • Conversation Text
      • User Started Speaking
      • Agent Thinking
      • Acknowledgements
      • Agent Audio Done
      • Errors & Warnings
      • History
  • 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 Payload
ControlsOutputs: Server Events

Settings Applied

Confirms the server has successfully received and applied the Settings message.
Was this page helpful?
Previous

Conversation Text

Facilitates real-time communication by relaying spoken statements from both the user and the agent.

Next
Built with
Voice Agent

The SettingsApplied message is a JSON message that confirms the server has successfully received and applied the Settings message.

Purpose

The SettingsApplied message confirms that the server has successfully received and applied the Settings message. This ensures synchronization between the client and server, providing assurance that the desired settings are now in effect. By sending this message, the server enables the voice agent to proceed with operations based on the updated configuration.

Example Payload

The server will send a SettingsApplied message as confirmation that the server received the Settings message.

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