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

Welcome

Receive a welcome message from the server to confirm the websocket has opened.
Was this page helpful?
Previous

Settings Applied

Confirms the server has successfully received and applied the Settings message.
Next
Built with
Voice Agent

The welcome message confirms there has been a successful connection to the websocket.

Purpose

The Welcome message serves as the initial handshake between a voice agent and the server, signaling that the websocket connection is successfully established. By including a unique request_id, it ensures that each interaction is traceable and distinct. This message is critical for synchronizing the client and server, enabling a voice agent to proceed with further actions.

Example Payload

The server will immediately send a Welcome message as soon as the websocket opens.

JSON
1{
2 "type": "Welcome",
3 "request_id": "fc553ec9-5874-49ca-a47c-b670d525a4b1"
4}