cURL
curl \
--request PUT \
--url "https://api.breeze.blue/v1/voices/voc_xeh3w54cqvnp/tags" \
--header "xi-api-key: $BREEZE_API_KEY"{
"voice_id": "<string>",
"name": "<string>",
"origin": "<string>",
"voice_type": "<string>",
"language_code": "af",
"gender": "male",
"age": "child",
"tone": [
"warm"
],
"accent": "american",
"tags": [
"<string>"
],
"is_favorited": false,
"preview_url": "<string>",
"description": "<string>",
"publication_status": "<string>",
"publication_job_id": "<string>",
"publication_error_code": "<string>",
"created_at_unix": 123
}{
"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": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}Voices
Update effective voice tags
Replace owner tags or a favoriting account’s complete personal override. An empty personal array resumes inheritance from the owner.
PUT
/
v1
/
voices
/
{voice_id}
/
tags
cURL
curl \
--request PUT \
--url "https://api.breeze.blue/v1/voices/voc_xeh3w54cqvnp/tags" \
--header "xi-api-key: $BREEZE_API_KEY"{
"voice_id": "<string>",
"name": "<string>",
"origin": "<string>",
"voice_type": "<string>",
"language_code": "af",
"gender": "male",
"age": "child",
"tone": [
"warm"
],
"accent": "american",
"tags": [
"<string>"
],
"is_favorited": false,
"preview_url": "<string>",
"description": "<string>",
"publication_status": "<string>",
"publication_job_id": "<string>",
"publication_error_code": "<string>",
"created_at_unix": 123
}{
"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": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}Continue building
List voices
Find voices using tag filters.
Get a voice
Read the effective tags.
Voice concepts
Understand voice identity and metadata.
Authorizations
Breeze Developer API key.
Path Parameters
Voice identifier returned by GET /v1/voices. See List voices.
Body
application/json
Tags to store. Spelling is preserved; values that differ only by case are duplicates. Maximum 20 values and 128 characters each. See Tags and favorites.
Maximum array length:
20Maximum string length:
128Response
Updated voice metadata.
Display name for the authenticated account. A saved public voice uses the personal alias set in Voice Library, when present.
Available options:
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 Available options:
male, female, neutral Available options:
child, young, middle_aged, old Maximum array length:
3Available options:
warm, calm, bright, gentle, energetic, authoritative, sincere, weary, precise, refined, urgent, friendly, articulate, steady, playful, compassionate, reflective, measured, rhythmic, passionate Available options:
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, mandarin_guangdong, mandarin_yunnan Maximum array length:
20Maximum string length:
128Owner-only publication review state: queued, processing, published, needs_review, failed, or superseded. Null when unavailable.