Skip to main content
POST
cURL

Continue building

Write instructions

Choose intent, emotion, and delivery.

Convert with timestamps

Get complete audio with word timing.

Stream text to speech

Receive audio as it is generated.

Text to speech

Follow HTTP, SDK, and async examples.

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Path Parameters

voice_id
string
required

Voice ID to use for speech generation. See List voices.

Query Parameters

output_format
enum<string>
default:mp3

The output format of the generated audio. For example, mp3_24000_128 is MP3 at 24 kHz and 128 kbps. Bitrate applies to MP3, AAC, and Opus. Default: mp3. See Output formats.

Available options:
mp3,
wav,
flac,
pcm,
aac,
opus,
mp3_24000_64,
mp3_24000_96,
mp3_24000_128,
mp3_24000_160,
wav_24000,
pcm_24000,
flac_24000,
aac_24000_128
delivery
string
default:sync

Response mode: sync returns audio; async returns a background job to poll. Default: sync. See Async jobs.

Pattern: ^(sync|async)$

Body

application/json
text
string
required

Text to synthesize. Up to 1000 characters by default; accounts with an approved higher limit may send up to their configured limit, at most 2000 characters. See Audio tags.

Minimum string length: 1
model_id
string | null

Model ID for speech generation. When omitted, the server selects a model based on the account rollout, requested language, and endpoint capabilities. See List models.

Required string length: 1 - 120
language_code
string | null

ISO 639-1 two-letter language code supported by the selected model. See supported language codes.

Required string length: 2
Pattern: ^[A-Za-z]{2}$
instructions
string | null

Performance instructions, written in the same language as the input text. Leading and trailing whitespace is removed. See Expressive controls, Voice instruction prompting.

voice_settings
TtsVoiceSettingsPayload · object | null

Per-request voice settings. See Expressive controls.

Response

Binary audio stream. Content-Type matches the requested output_format.

The response is of type file.