Skip to main content
PATCH
cURL
Currently, displayName is the only editable field. The updateMask query parameter is required and uses snake_case field paths (for example: ?updateMask=display_name) — an empty or missing mask returns 400.
Editing a failed voice. Updating a voice in PVC_VOICE_STATE_FAILED returns it to PVC_VOICE_STATE_DRAFT and preserves its existing samples, so you can add or remove samples and retrain without re-uploading everything.
A voice that is queued, training, or ready cannot be updated — this endpoint returns 409 until the voice finishes (or, for a failed voice, until you next edit it).

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 of the PVC voice to update.

Query Parameters

updateMask
string
required

Comma-separated list of fields to update. Required — an empty or missing mask returns 400. Fields present in the body but omitted from the mask are ignored.

Mask paths use snake_case field names, even though the request body uses camelCase. Supported paths: display_name.

Example:

"display_name"

Body

application/json

Request message for UpdatePvcVoice. updateMask is required.

displayName
string

The voice's new display name. Include display_name (snake_case) in updateMask to apply this field.

Response

A successful response.

A Professional Voice Clone resource.

name
string
read-only

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

voiceId
string
read-only

Voice ID, derived from displayName at creation time. Use this value as {voiceId} on every other PVC endpoint, and as the voiceId in TTS synthesis requests once the voice is PVC_VOICE_STATE_READY.

displayName
string

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

languageCode
string

The voice's language as a BCP-47-shaped locale string, e.g. en-US. Immutable after creation.

state
enum<string>

Lifecycle state of a PVC voice.

  • PVC_VOICE_STATE_DRAFT: Editable. Samples can be added, trimmed, or removed, and metadata can be updated.
  • PVC_VOICE_STATE_QUEUED: Training requested; waiting for a training slot.
  • PVC_VOICE_STATE_TRAINING: Actively training.
  • PVC_VOICE_STATE_READY: Training succeeded. Usable for TTS synthesis; permanent — cannot be deleted through this API.
  • PVC_VOICE_STATE_FAILED: Training failed. Editing the voice (e.g. renaming it, or adding/removing a sample) returns it to PVC_VOICE_STATE_DRAFT with its remaining samples intact.
Available options:
PVC_VOICE_STATE_UNSPECIFIED,
PVC_VOICE_STATE_DRAFT,
PVC_VOICE_STATE_QUEUED,
PVC_VOICE_STATE_TRAINING,
PVC_VOICE_STATE_READY,
PVC_VOICE_STATE_FAILED
failure
object

Populated on a PVC voice when its state is PVC_VOICE_STATE_FAILED.

incarnationId
string
read-only

Identifier that stays stable across edits to the same voice, and changes each time it is retrained. Use it to tell two reads of the same voiceId apart across a retrain.

samples
object[]
read-only

Audio samples currently attached to the voice.

createTime
string<date-time>
read-only
updateTime
string<date-time>
read-only