Save voice preview

Save a generated preview as a private voice. Voice Metadata values are stable lowercase codes; tone accepts up to three distinct codes. language_code is required. accent is available only for en and zh and must match language_code.

POST /v1/voice-previews/{generated_voice_id}/save

cURL

cURL

curl \
  --request POST \
  --url "https://api.breeze.blue/v1/voice-previews/gvi_01hpreview/save" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "voice_name": "Brand Narrator"
}'

200

{
  "voice_id": "<string>",
  "name": "<string>",
  "origin": "<string>",
  "language_code": "ar",
  "gender": "male",
  "age": "child",
  "tone": [
    "warm"
  ],
  "accent": "american",
  "tags": [
    "<string>"
  ],
  "is_favorited": false,
  "preview_url": "<string>",
  "description": "<string>",
  "created_at_unix": 123
}

Authorizations

xi-api-key · string · header · required

Breeze Developer API key.

Path Parameters

generated_voice_id · string · required

Preview ID returned by a voice preview creation endpoint.

Body

application/json

voice_name · string · required

Display name for the saved voice. Maximum 80 characters.

Required string length: 1 - 80

gender · enum<string> | null

Stable gender code, or null when not classified.

Available options: male, female, neutral

age · enum<string> | null

Stable age code, or null when not classified.

Available options: child, young, middle_aged, old

tone · enum<string>[]

Zero to three distinct stable tone codes.

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, or null. Valid only for en or zh and must match language_code.

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

voice_description · string | null

Optional description stored with the saved voice.

Maximum string length: 1000

language_code · enum<string> | null

Required saved audio language from the 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

tags · string[]

Canonical lowercase tags stored with the saved voice.

Maximum array length: 20

Maximum string length: 128

Response

200

application/json

Saved voice.

voice_id · string · required

name · string · required

origin · string · required

language_code · enum<string> · required

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 · required

Available options: male, female, neutral

age · enum<string> | null · required

Available options: child, young, middle_aged, old

tone · enum<string>[] · required

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 · required

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

tags · string[]

Maximum array length: 20

Maximum string length: 128

is_favorited · boolean · default: false

preview_url · string | null

description · string | null

created_at_unix · integer | null