Skip to main content
POST
cURL

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:pcm

Streaming output encoding. Supported values: pcm, mp3, wav. Default: pcm for lower time to first audio.

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 ISO 639-1 two-letter language code. The selected model must list the code in supported_languages.

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

Optional performance instructions for the generation. Use Chinese for Chinese TTS and English for English or any other language. Developer API requests do not translate instructions automatically.

voice_settings
VoiceSettingsPayload · object | null

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.