Skip to main content
POST
/
v1
/
voice-previews
/
design
cURL
curl \
  --request POST \
  --url "https://api.breeze.blue/v1/voice-previews/design" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "voice_description": "Warm, intimate narrator with crisp diction.",
  "text": "Welcome to Breeze Blue.",
  "language_code": "en",
  "guidance_scale": 4.0,
  "preview_count": 3
}'
{
  "previews": [
    {
      "generated_voice_id": "<string>",
      "audio_base_64": "<string>",
      "media_type": "<string>",
      "duration_secs": 123
    }
  ],
  "text": "<string>"
}

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Query Parameters

output_format
string | null
default:mp3

Audio format for the embedded preview payloads. Supported values: mp3, wav, flac, pcm, aac, opus. Default: mp3.

Body

application/json
voice_description
string
required

Text description of the desired voice.

Required string length: 3 - 500
text
string | null

Optional preview script for the generated voice previews.

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 language hint for the generated previews.

Maximum string length: 16
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
preview_count
integer | null

Number of preview variants to generate. Defaults to 1 and accepts values from 1 to 3.

Required range: 1 <= x <= 3

Response

Generated voice previews.

previews
VoiceDesignPreviewResponse · object[]
required
text
string
required