Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

providerVoiceId
string
required

The voice id as the speech provider knows it: the id used when the voice was added.

Minimum string length: 1

Response

Removal impact.

What removing a voice would do, without doing it.

success
boolean
required
agentCount
integer
required

Agents currently speaking with this voice.

Required range: x >= 0
Example:

2

agentNames
string[]
required

Their names, for the confirmation. Unnamed agents are omitted, so this can be shorter than agentCount.

Example:
fallbackVoiceId
string
required

The voice those agents would be moved to.

Example:

"custom_voice_c5dae0d6c48a6ae36bac9bbcd0"