Streaming

One POST, one chunked response. The body is raw 16-bit little-endian PCM — no WAV header — prefixed by a 4-byte little-endian sample rate, so a client can start scheduling samples as they arrive.

Authentication

Same account API key and tts:synthesize scope as buffered synthesis. voice_id is REQUIRED here: the streaming engine clones a reference voice, so there is no default to fall back on.

Create a key in Settings → API Keys. It is shown once, so copy it then. Every example below reads it from $SONICVOX_API_KEY.

Endpoints

# Write the raw PCM to a file. Note --no-buffer: without it curl
# holds the response and you lose the point of streaming.
curl https://staging.sonicvox.ai/api/v1/text-to-speech/stream \
  -H "sv-api-key: $SONICVOX_API_KEY" \
  -H "content-type: application/json" \
  --no-buffer \
  -d '{
    "text": "Streaming starts playing before it finishes.",
    "voice_id": "cmpwrfi46015zkww3t8nui4ye",
    "language": "en"
  }' \
  --output stream.pcm

HTTP/1.1 200 OK
content-type: application/octet-stream
transfer-encoding: chunked
x-audio-format: pcm_s16le
x-credits-charged: 100

<4-byte LE sample rate><PCM frames…>

When it fails

Every error carries type, code, message, request_id and a doc_url. Branch on type for retry policy.

Next