Sign in

v1

latestOpenAPI 3.0.02026-07-262088144.5 KB
VoiceService

Clone a voice

Clone a voice from audio samples.

post/voices/v1/voices:clone

Request body

displayNamestring required

The human-readable name shown anywhere the voice is listed or selected. Keep it short and distinctive so users can find it easily.

langCode'EN_US' | 'ZH_CN' | 'KO_KR' | 'JA_JP' | 'RU_RU' | 'AUTO' | 'IT_IT' | 'ES_ES' | 'PT_BR' | 'DE_DE' | 'FR_FR' | 'AR_SA' | 'PL_PL' | 'NL_NL' | 'HI_IN' | 'HE_IL'

Legacy enum encoding of the voice's language. The full accepted set is much larger than the values listed here: every supported locale has an enum name (the locale with - replaced by _, uppercased — en-GB becomes EN_GB). Prefer the languageCode string field on new integrations. AUTO (or omitting the language entirely) auto-detects the language.

languageCodestring

The voice's language as a canonical BCP-47-shaped locale string (e.g. en-US, en-GB, vi). Set at most one of languageCode or langCode — they are two encodings of the same value. Matching is case- and separator-insensitive (en-gb, EN_GB and en-GB are equivalent); a bare language code with no region (e.g. en, pt) selects the language's default accent. Omit both fields to auto-detect the language (equivalently: langCode: "AUTO" or languageCode: "auto"). Values outside the supported catalog are rejected with INVALID_ARGUMENT. See Languages for the supported set.

descriptionstring

Longer blurb that explains the voice's tone, accent, use cases, or other relevant attributes. Helpful for search and selection.

tagsstring[]

Free-form labels for filtering, grouping, and discovery (e.g. ["british", "calm"]). This is not where gender or age go — those are separate fields set via UpdateVoice after cloning.

Response

A successful response.

Example response

{
  "voice": {
    "name": "workspaces/your_workspace_id/voices/my_voice_clone_demo_20260218_223134z",
    "voiceId": "your_workspace_id__my_voice_clone_demo_20260218_223134z",
    "langCode": "EN_US",
    "displayName": "John",
    "description": "Cloned voice for narrations.",
    "tags": [
      "demo",
      "clone"
    ],
    "categories": [],
    "source": "IVC",
    "gender": "",
    "ageGroup": "",
    "promptLanguages": [
      "en-US"
    ]
  }
}