Skip to main content
PATCH
cURL
Short URL Path: /workspaces/{workspace} is no longer required in the path for simplicity and clarity. When omitted, the workspace is derived from your API key. The previous URL with the full path /voices/v1/workspaces/{workspace}/voices/{voice} would continue to be supported.

Setting gender, age group, and categories on a cloned voice

These fields can’t be set at clone time — CloneVoice accepts only displayName, langCode, voiceSamples, description, tags, and audioProcessingConfig. To populate them, PATCH the voice after cloning. The updateMask query parameter controls which fields actually get applied — any field in the body but missing from the mask is silently ignored. Mask paths use snake_case field names (e.g. age_group), even though the request body uses camelCase (ageGroup). Passing the camelCase form (?updateMask=gender,ageGroup) silently fails for multi-word fields.
<voice-id> is the voiceId returned by CloneVoice, in the format {workspace}__{voice}. Response (200):
Accepted values:
  • gender: "male", "female", "neutral"
  • ageGroup: "young", "middle_aged", "elderly"
  • categories: "companions", "developer_assistants", "education_training", "enterprise", "healthcare", "interactive_media"
Unlike gender and ageGroup (which are silently dropped if you misuse the mask), an invalid categories value returns HTTP 400 and rejects the entire request — including any valid categories in the same list.

Authorizations

Authorization
string
header
required

Your API key. Read permissions are required for GET endpoints. Write permissions are required for POST, PATCH, and DELETE endpoints.

For Basic authentication, please populate Basic $INWORLD_API_KEY. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Path Parameters

voiceId
string
required

Voice ID containing the voice to update. Expected format: {workspace}__{voice}.

Pattern: [^/]+

Query Parameters

updateMask
string

Comma-separated list of fields to update. Paths use snake_case field names, even though the request body uses camelCase. Supported paths: display_name, description, tags, gender, age_group, categories. Fields present in the body but omitted from updateMask are ignored.

Example:

"gender,age_group"

Body

application/json

The voice resource to update

displayName
string

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

description
string

Description of the voice, such as the voice's tone, accent, use cases, or other relevant attributes. Helpful for search and selection.

tags
string[]

Free-form labels for filtering, grouping, and discovery (e.g. ["british", "calm"]). Structured metadata like gender and age has dedicated fields — see gender, ageGroup, and categories below.

gender
enum<string>

Voice gender. Include gender in updateMask to apply this field.

Available options:
male,
female,
neutral
ageGroup
enum<string>

Age group of the voice. Include age_group (snake_case) in updateMask to apply this field.

Available options:
young,
middle_aged,
elderly
categories
enum<string>[]

Use-case categories the voice belongs to. Include categories in updateMask to apply this field. An invalid value returns HTTP 400 and rejects the whole request (all-or-nothing), unlike gender/ageGroup which are silently dropped when the mask is wrong.

Available options:
companions,
developer_assistants,
education_training,
enterprise,
healthcare,
interactive_media

Response

A successful response.

Voice resource representing a voice configuration.

voiceId
string
read-only

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

langCode
enum<string>

Primary language of the voice in upper-snake format (e.g. EN_US). Note that when filtering via lang_code, you can pass BCP-47 (en-US), underscore form (en_US), or a language prefix (en) — but the response always returns upper-snake.

Available options:
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
displayName
string

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

description
string

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

tags
string[]

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

name
string

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

source
enum<string>

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.
Available options:
SYSTEM,
IVC,
PVC
gender
enum<string>

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

Available options:
male,
female,
neutral,
ageGroup
enum<string>

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

Available options:
young,
middle_aged,
elderly,
categories
enum<string>[]

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

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

Available options:
companions,
enterprise,
education_training,
developer_assistants,
healthcare,
interactive_media
promptLanguages
string[]

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