Skip to main content
POST
cURL
Language. Only en-US is currently supported for Professional Voice Cloning. languageCode is immutable after creation.
Each voice claims one of your plan’s PVC voice slots for as long as it exists. Check your usage with Resolve upload limits (usedPvcVoiceSlots / maxPvcVoiceSlots); when all slots are taken, creation is refused until a slot is freed or the plan is upgraded. On-Demand accounts also need a payment method on file. Creates a new voice in PVC_VOICE_STATE_DRAFT. A draft voice has no audio yet — build it out with the rest of this API before training:
1

Create the draft voice

This endpoint. Returns a voiceId derived from displayName.
2

Upload audio samples

Upload PVC voice samples — repeat until you have at least 10 minutes of cumulative audio. Optionally trim individual samples with Trim a PVC voice sample.
3

Train

Train a PVC voice starts training and moves the voice to PVC_VOICE_STATE_QUEUED.
4

Poll until ready

Get a PVC voice to watch state progress to PVC_VOICE_STATE_READY (or PVC_VOICE_STATE_FAILED). Once ready, use the voiceId anywhere you’d use a regular voice, e.g. Synthesize speech.
For recording and preparation tips, see Voice Cloning best practices.

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.

Body

application/json

Request message for CreatePvcVoice.

displayName
string
required

The human-readable name shown anywhere the voice is listed or selected. The voice's voiceId is derived from this value; renaming the voice later does not change its voiceId.

languageCode
string

The voice's language as a BCP-47-shaped locale string. Currently only en-US is supported for Professional Voice Cloning; defaults to en-US if omitted. Immutable after creation.

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