curl --location 'https://api.inworld.ai/voices/v1/pvcVoices/<voice-id>' \
--header "Authorization: Basic $INWORLD_API_KEY"import requests
voice_id = "<voice-id>"
url = f"https://api.inworld.ai/voices/v1/pvcVoices/{voice_id}"
headers = {"Authorization": "Basic <api-key>"}
response = requests.get(url, headers=headers)
print(response.json())const voiceId = '<voice-id>';
const url = `https://api.inworld.ai/voices/v1/pvcVoices/${voiceId}`;
const response = await fetch(url, {
headers: { 'Authorization': 'Basic <api-key>' },
});
const data = await response.json();
console.log(data);{
"name": "workspaces/your_workspace_id/pvcVoices/my-professional-voice",
"voiceId": "my-professional-voice",
"displayName": "my-professional-voice",
"languageCode": "en-US",
"state": "PVC_VOICE_STATE_TRAINING",
"incarnationId": "a1b2c3d4",
"samples": [
{
"sampleId": "s_9f1c2e",
"name": "workspaces/your_workspace_id/pvcVoices/my-professional-voice/samples/s_9f1c2e",
"sizeBytes": 24883220,
"durationSecs": 312.4,
"mimeType": "audio/wav",
"hash": "<base64-gcs-md5>"
}
],
"createTime": "2026-08-31T12:00:00Z",
"updateTime": "2026-08-31T12:15:00Z"
}Get a PVC voice
Reads a Professional Voice Clone’s current state, including its uploaded samples. Poll this endpoint after training to watch a voice move from PVC_VOICE_STATE_QUEUED through PVC_VOICE_STATE_TRAINING to PVC_VOICE_STATE_READY (or PVC_VOICE_STATE_FAILED).
curl --location 'https://api.inworld.ai/voices/v1/pvcVoices/<voice-id>' \
--header "Authorization: Basic $INWORLD_API_KEY"import requests
voice_id = "<voice-id>"
url = f"https://api.inworld.ai/voices/v1/pvcVoices/{voice_id}"
headers = {"Authorization": "Basic <api-key>"}
response = requests.get(url, headers=headers)
print(response.json())const voiceId = '<voice-id>';
const url = `https://api.inworld.ai/voices/v1/pvcVoices/${voiceId}`;
const response = await fetch(url, {
headers: { 'Authorization': 'Basic <api-key>' },
});
const data = await response.json();
console.log(data);{
"name": "workspaces/your_workspace_id/pvcVoices/my-professional-voice",
"voiceId": "my-professional-voice",
"displayName": "my-professional-voice",
"languageCode": "en-US",
"state": "PVC_VOICE_STATE_TRAINING",
"incarnationId": "a1b2c3d4",
"samples": [
{
"sampleId": "s_9f1c2e",
"name": "workspaces/your_workspace_id/pvcVoices/my-professional-voice/samples/s_9f1c2e",
"sizeBytes": 24883220,
"durationSecs": 312.4,
"mimeType": "audio/wav",
"hash": "<base64-gcs-md5>"
}
],
"createTime": "2026-08-31T12:00:00Z",
"updateTime": "2026-08-31T12:15:00Z"
}samples array lists every sample currently attached to the voice, including each sample’s sampleId — use it to trim or delete that sample.
state move from PVC_VOICE_STATE_QUEUED to PVC_VOICE_STATE_TRAINING to PVC_VOICE_STATE_READY. If it lands on PVC_VOICE_STATE_FAILED instead, the failure.message field has a scrubbed description of what went wrong.404 from this endpoint means either the voice doesn’t exist, or it belongs to a different workspace than the one resolved from your API key — the two cases are deliberately indistinguishable.Authorizations
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
Voice ID of the PVC voice to get.
Response
A successful response.
A Professional Voice Clone resource.
Resource name. Format: workspaces/{workspace}/pvcVoices/{voice}.
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.
The human-readable name shown anywhere the voice is listed or selected.
The voice's language as a BCP-47-shaped locale string, e.g. en-US. Immutable after creation.
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 toPVC_VOICE_STATE_DRAFTwith its remaining samples intact.
PVC_VOICE_STATE_UNSPECIFIED, PVC_VOICE_STATE_DRAFT, PVC_VOICE_STATE_QUEUED, PVC_VOICE_STATE_TRAINING, PVC_VOICE_STATE_READY, PVC_VOICE_STATE_FAILED Populated on a PVC voice when its state is PVC_VOICE_STATE_FAILED.
Show child attributes
Show child attributes
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.
Audio samples currently attached to the voice.
Show child attributes
Show child attributes