Skip to main content
POST
cURL

Continue building

Remixing a voice

Generate, audition, and save remixed previews.

Get remix preview

Poll the returned generation job.

List Voice Metadata options

Check voice language and metadata codes.

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Body

application/json

Create one same-language candidate from an owned or official voice.

voice_id
string
required

Owned or available official voice ID. Third-party favorites do not grant remix access. See List voices.

Required string length: 1 - 64
prompt
string | null

Desired voice change. Required unless preset_id selects a preset. Custom and edited preset descriptions are enhanced automatically.

Required string length: 3 - 1000
preset_id
string | null

ID from the remix preset catalog. An unchanged preset bypasses Enhance; language differences are translated faithfully.

Required string length: 1 - 64
guidance_scale
number
default:4

Instruction following strength, 1–10. Default 4 (Expressive); 2 is Stable, 6 Creative, 8 Intense. See Voice settings.

Required range: 1 <= x <= 10
preparation_token
string | null

Optional token from prepare. Reuse it with the same input to keep candidate instructions and scripts identical. Without it, input is prepared before generation.

Required string length: 1 - 24000

Response

Accepted background voice remix job.

generation_job_id
string
required
status
string
required