Edit a voice

Update a saved voice. Metadata values are stable lowercase codes. Omit a metadata field to preserve it; send an empty string to clear gender, age, or accent, and send one empty tone field to clear tone. When language_code changes and the existing accent is no longer valid, Breeze clears accent automatically. Replacing reference audio requires the new sample’s language_code unless Breeze can detect it.

PATCH /v1/voices/{voice_id}

cURL

cURL

curl \
  --request PATCH \
  --url "https://api.breeze.blue/v1/voices/voc_xeh3w54cqvnp" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --form "name=Brand Narrator v2" \
  --form "description=Updated voice description for the saved clone." \
  --form "files=@sample.wav;type=audio/wav"

200

{
  "status": "<string>"
}

Authorizations

xi-api-key · string · header · required

Breeze Developer API key.

Path Parameters

voice_id · string · required

Saved voice identifier returned by GET /v1/voices.

Body

multipart/form-data

name · string | null

New display name. Maximum 80 characters.

Maximum string length: 80

description · string | null

New description.

tags · string[] | null

Maximum array length: 20

Maximum string length: 128

language_code · enum<string> | null

Saved audio language. Existing 23-language code contract.

Available options: ar, cs, de, el, en, es, fi, fr, hi, id, it, ja, ko, nl, pl, pt, ro, ru, th, tr, uk, vi, zh

gender · enum<string> | null

Stable gender code. Empty string clears the value.

Available options: male, female, neutral

age · enum<string> | null

Stable age code. Empty string clears the value.

Available options: child, young, middle_aged, old

tone · enum<string>[] | null

Repeat this field for up to three distinct tone codes. One empty field clears the array.

Maximum array length: 3

Available options: warm, calm, bright, gentle, energetic, authoritative, sincere, weary, precise, refined, urgent, friendly, articulate, steady, playful, compassionate, reflective, measured, rhythmic, passionate

accent · enum<string> | null

Stable accent code. Valid only for en or zh and must match language_code. Empty string clears the value.

Available options: american, british, scottish, irish, australian, canadian, us_southern, us_new_york, indian, south_african, russian, japanese, korean, chinese, mandarin_guangdong, mandarin_northeastern, mandarin_shaanxi, mandarin_shanghai, mandarin_sichuan, mandarin_yunnan, mandarin_henan, cantonese

Response

200

application/json

Update status.

status · string · required