v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
pvc-voices

Retrieve Speaker Separation Status

Retrieve the status of the speaker separation process and the list of detected speakers if complete.

get/v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers

Path parameters

voice_idstring required

Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.

Example:21m00Tcm4TlvDq8ikWAM

Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.

sample_idstring required

Sample ID to be used

Example:VW7YKqPnjY4h39yTbx2L

Sample ID to be used

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

voice_idstring required

The ID of the voice.

sample_idstring required

The ID of the sample.

status'not_started' | 'pending' | 'completed' | 'failed' required

The status of the speaker separation.

speakersobject nullable

The speakers of the sample.

selected_speaker_idsstring[] nullable

The IDs of the selected speakers.

Example response

{
  "sample_id": "DCwhRBWXzGAHq8TQ4Fs18",
  "status": "not_started",
  "voice_id": "DCwhRBWXzGAHq8TQ4Fs18"
}