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

User Started Speaking

Notifies the client that the user has begun speaking.
Was this page helpful?
Previous

Agent Thinking

Informs the client when the agent is processing information.
Next
Built with
Voice Agent

The userStartedSpeaking message confirms when a user begins to speak.

Purpose

The UserStartedSpeaking message is sent by the server to notify the client that the user has begun speaking, prompting the client to stop any ongoing agent audio playback and discard any buffered audio, ensuring that the user’s input is prioritized and processed immediately.

Example Payload

The server will send a UserStartedSpeaking message every time the user begins a new utterance. If the client is playing agent audio when this message is received, it should stop playback immediately and discard all of its buffered agent audio.

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