Stream Speech
POSThttps://api.knoxstudio.ai/v1/text-to-speech/:voice_id/stream
Same JSON body as Create speech, but audio is streamed. WAV output_format values are not allowed on stream paths.
Request
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| voice_id | String | Yes | ElevenLabs voice ID. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| enable_logging | Boolean | No | Default true. false requests zero-retention mode. |
| optimize_streaming_latency | Integer | No | Deprecated. 0–4 latency/quality tradeoff. |
| output_format | String | No | Default mp3_44100_128. Format is codec_sample_rate_bitrate. |
Allowed output_format (no WAV): mp3_22050_32, mp3_24000_48, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_8000, pcm_16000, pcm_22050, pcm_24000, pcm_32000, pcm_44100, pcm_48000, ulaw_8000, alaw_8000, opus_48000_32, opus_48000_64, opus_48000_96, opus_48000_128, opus_48000_192.
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | Bearer <token> Knox API key. xi-api-key is also accepted. |
| Content-Type | String | Yes | application/json. |
Request Body
Same fields as Create speech.
cURL Example
curl -N -X POST "https://api.knoxstudio.ai/v1/text-to-speech/21m00Tcm4TlvDq8ikWAM/stream?output_format=mp3_44100_128" \
-H "Authorization: Bearer $KNOXCHAT_API_KEY" \
-H "Content-Type: application/json" \
-o speech.mp3 \
-d '{
"text": "Streaming speech from Knox.",
"model_id": "eleven_flash_v2_5"
}'
Response
Success Response (200)
Streaming audio bytes.
Error Responses
Validation uses HTTP 422:
{
"detail": [
{
"loc": ["body", "field"],
"msg": "…",
"type": "value_error"
}
]
}
Other errors use { "detail": "message" }.
| Status | When |
|---|---|
400 | WebSocket path called without Upgrade: websocket. |
401 | Missing or invalid API key. |
402 | Insufficient credits. |
403 | Token is not allowed to use this model. |
404 | Resource not found. |
422 | Validation error. |
429 | Rate limit exceeded. |
500 | Internal server error. |