Skip to main content
POST
cURL

Continue building

Design a voice

Write a voice description and preview script.

Create design previews

Generate and compare encoded previews.

Save voice preview

Save a reusable voice for TTS.

Write instructions

Choose intent, emotion, and delivery.

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. See Voice Design prompting.

Required string length: 3 - 500
text
string | null

Preview script. Breeze uses a default script when omitted. See Audio tags.

Required string length: 3 - 500
model_id
string | null

Model ID for voice generation. See List models.

Required string length: 1 - 120
language_code
string | null

Optional ISO 639-1 two-letter preview language. See supported language codes.

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

Optional guidance strength from 1.0 to 10.0. When omitted or null, BreezeBlue samples uniformly between 1.0 and 4.0 and rounds to one decimal place. See Voice Design controls.

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.