Skip to main content
PATCH
/
voices
/
v1
/
voices
/
{voiceId}
cURL
curl --location --request PATCH 'https://api.inworld.ai/voices/v1/voices/<voice-id>' \
--header 'Authorization: Basic <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "John",
  "description": "Cloned voice for narrations.",
  "tags": ["demo", "clone"]
}'
{
  "voiceId": "your_workspace_id__my_voice_clone_demo_20260218_223134z",
  "langCode": "EN_US",
  "displayName": "John",
  "description": "Cloned voice for narrations.",
  "tags": [
    "demo",
    "clone"
  ],
  "name": "workspaces/your_workspace_id/voices/my_voice_clone_demo_20260218_223134z",
  "source": "IVC"
}
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.

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

Path Parameters

​
voiceId
string
required

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

Pattern: [^/]+

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[]

Flat list of labels used for filtering, grouping and discovery. Examples could include gender, age or use case.

Response

A successful response.

Voice resource representing a voice configuration.

​
voiceId
string

ID of the voice. Format: {workspace}__{voice}.

​
langCode
enum<string>
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. Helpful for search and selection.

​
tags
string[]

Flat list of labels used for filtering, grouping and discovery. Examples could include gender, age or use case.

​
name
string

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

​
source
enum<string>

The source of the voice:

  • SYSTEM: Built-in voice provided by Inworld.
  • IVC: Instant Voice Clone—user-cloned voice from audio, or voice created via Text Voice Design.
  • PVC: Professional Voice Cloning.
Available options:
SYSTEM,
IVC,
PVC