Skip to main content
POST
cURL

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Body

application/json

Single-preview request contract for live PCM voice design audio.

voice_description
string
required

Text description of the desired voice.

Required string length: 3 - 500
text
string | null

Preview script. Breeze uses a default script when omitted.

Required string length: 3 - 500
model_id
string | null

Optional model identifier to use for generation.

Required string length: 1 - 120
language_code
string | null

Optional ISO 639-1 two-letter preview language.

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

Optional generation guidance strength for preview generation. Accepted range: 1.0 to 10.0. When provided, that exact value is used; when omitted, Breeze picks a random value between 1.0 and 10.0 for the request.

Required range: 1 <= x <= 10

Response

Live 24 kHz mono signed 16-bit little-endian PCM audio. A clean EOF means the preview is persisted and can be saved.

The response is of type file.