Sign in

v1

latestOpenAPI 3.0.02026-07-262088144.5 KB
VoiceService

Gets a specific voice

get/voices/v1/voices/{voiceId}

Path parameters

voiceIdstring required

Voice ID of the voice to get.

Response

A successful response.

voiceIdstring

Voice ID. SYSTEM voices use a simple name (e.g. Alex); IVC voices are workspace-prefixed ({workspace}__{voice}).

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

Canonical wire form of the voice's primary language as a single string (e.g. en-US, es-MX, vi). Populated on every read alongside the legacy langCode enum. Immutable after creation.

displayNamestring

The human-readable name shown anywhere the voice is listed or selected.

descriptionstring

Longer blurb that explains the voice's tone, accent, use cases, or other relevant attributes.

tagsstring[]

Free-form labels for filtering, grouping, and discovery (e.g. british, calm).

namestring

Resource name. Format: workspaces/{workspace}/voices/{voice}.

source'SYSTEM' | 'IVC' | 'PVC'

Origin of the voice:

  • SYSTEM: Built-in voice provided by Inworld, visible to all workspaces.
  • IVC: Voice cloned from audio or created via Voice Design — owned by your workspace only.
  • PVC: Professional Voice Clone.
gender'male' | 'female' | 'neutral' | ''

Voice gender (male, female, neutral). Empty string if unspecified. Voices with no gender are excluded when filtering with an explicit gender = predicate.

ageGroup'young' | 'middle_aged' | 'elderly' | ''

Age group of the voice (young, middle_aged, elderly). Empty string if unspecified.

categoriesstring[]

Use-case categories the voice belongs to. Filterable with the : (has) operator.

Supported values: companions, enterprise, education_training, developer_assistants, healthcare, interactive_media.

promptLanguagesstring[]

Languages the voice can handle, in BCP-47 format (e.g. en-US). May differ from langCode for multilingual voices.

Example response

{
  "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"
  ]
}