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 "[email protected];type=audio/wav"from pathlib import Path
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
client.voices.edit(
"voc_xeh3w54cqvnp",
name="Brand Narrator v2",
description="Updated voice description for the saved clone.",
file=Path("sample.wav"),
)import { readFile } from "node:fs/promises";
import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
await client.voices.edit("voc_xeh3w54cqvnp", {
name: "Brand Narrator v2",
description: "Updated voice description for the saved clone.",
file: {
data: await readFile("sample.wav"),
filename: "sample.wav",
contentType: "audio/wav",
},
});{
"status": "<string>",
"visibility": "<string>",
"publication_status": "<string>",
"publication_job_id": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}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.
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 "[email protected];type=audio/wav"from pathlib import Path
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
client.voices.edit(
"voc_xeh3w54cqvnp",
name="Brand Narrator v2",
description="Updated voice description for the saved clone.",
file=Path("sample.wav"),
)import { readFile } from "node:fs/promises";
import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
await client.voices.edit("voc_xeh3w54cqvnp", {
name: "Brand Narrator v2",
description: "Updated voice description for the saved clone.",
file: {
data: await readFile("sample.wav"),
filename: "sample.wav",
contentType: "audio/wav",
},
});{
"status": "<string>",
"visibility": "<string>",
"publication_status": "<string>",
"publication_job_id": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}Continue building
List Voice Metadata options
Get a voice
Update effective voice tags
Authorizations
Breeze Developer API key.
Path Parameters
Saved voice identifier returned by GET /v1/voices. See List voices.
Body
New display name. Maximum 80 characters.
1 - 80New description.
Saved audio language. Use a supported language code. See supported language codes.
af, ar, bg, bn, bs, ca, cs, da, de, el, en, es, et, eu, fa, fi, fr, gl, he, hi, hu, id, is, it, ja, kn, ko, lt, mr, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sq, sv, sw, ta, te, th, tl, tr, uk, ur, vi, zh Stable gender code. Empty string clears the value. See Metadata options.
male, female, neutral Stable age code. Empty string clears the value. See Metadata options.
child, young, middle_aged, old Repeat this field for up to three distinct tone codes. One empty field clears the array. See Metadata options.
3warm, calm, bright, gentle, energetic, authoritative, sincere, weary, precise, refined, urgent, friendly, articulate, steady, playful, compassionate, reflective, measured, rhythmic, passionate Stable accent code. Valid only for en or zh and must match language_code. Empty string clears the value. See Metadata options, accent codes.
american, british, scottish, irish, australian, canadian, us_southern, us_new_york, indian, south_african, russian, japanese, korean, chinese, mandarin_northeastern, mandarin_shaanxi, mandarin_shanghai, mandarin_sichuan, mandarin_henan, mandarin_beijing, mandarin_taiwan, cantonese