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.
Status
OverviewProductsManageAPI ReferenceTutorialsClient Libraries
OverviewProductsManageAPI ReferenceTutorialsClient Libraries
    • Overview
  • Quickstarts
    • Synthesize Your First Clip
    • Prompted Synthesis
  • Voice Creation
    • Voice Design Guide
  • WebSocket Streaming
    • Getting Started
    • Receiving Audio Data
    • Python Example
    • Error Handling
  • Prompt Engineering
    • Voice Design Prompting
    • SSML Prompts
Status
LogoLogo
On this page
  • Key Features
WebSocket Streaming

Getting Started

Was this page helpful?
Previous

Receiving Audio Data

Next
Built with

The WebSocket API delivers low-latency text-to-speech streaming. Use it when you need immediate playback, conversational agents, or continuous audio synthesis.

Key Features

  • Real-time audio – Receive PCM or MP3 chunks as they are generated.
  • Flexible payloads – Choose JSON frames (base64) or raw binary streams.
  • Connection-aware errors – Separate recoverable synthesis errors from unrecoverable connection failures.

Before you stream:

  1. Confirm your account has Business-plan WebSocket access.
  2. Retrieve your API token (Authorization: Bearer ...).
  3. Select an eligible voice_uuid.

Continue with Receiving Audio for request parameters and response shapes.