Skip to main content
POST
/
v1
/
text-to-speech
/
{voice_id}
/
stream
cURL
curl \
  --request POST \
  --url "https://api.breeze.blue/v1/text-to-speech/voc_xeh3w54cqvnp/stream" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "text": "I can’t believe you brought him here!",
  "model_id": "bluebell-v1-en",
  "language_code": "en",
  "instructions": "Say it softly and emotionally, with a hurt, disappointed tone, as if bringing him here broke your trust.",
  "voice_settings": {
    "guidance_scale": 4.0
  }
}'
"<string>"

Authorizations

​
xi-api-key
string
header
required

Breeze Developer API key.

Path Parameters

​
voice_id
string
required

Voice identifier to synthesize. Use GET /v1/voices to discover available IDs.

Query Parameters

​
output_format
string | null
default:mp3

Streaming output encoding. Supported values: mp3, pcm. Default: mp3.

Body

application/json
​
text
string
required

Text to synthesize.

Minimum string length: 1
​
model_id
string | null

Optional model identifier to use for synthesis.

Required string length: 1 - 120
​
language_code
string | null

Optional BCP-47 style language hint such as en.

Maximum string length: 16
​
instructions
string | null

Optional performance instructions for the generation.

​
voice_settings
VoiceSettingsPayload · object

Optional per-request voice settings override.

Response

Streaming audio bytes. The history-item-id header identifies the persisted generation.

The response is of type file.