Skip to main content
DELETE
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

Voice removed.

The library after the removal, plus what had to be moved off the voice.

success
boolean
required
voices
object[]
required
used
integer
required
Required range: x >= 0
Example:

0

limit
integer | null
required
Required range: x >= 0
Example:

5

remaining
integer | null
required
Required range: x >= 0
Example:

5

reassignedAgents
integer
required

Agents that were speaking with this voice and have been moved to the default one. Reported so the caller can say so rather than leaving it to be discovered on the next call.

Required range: x >= 0
Example:

2

incompleteAgents
integer
required

Agents that could NOT be moved. The removal still succeeded; this is the only signal that one of them still needs attention, so treat a non-zero value as work to do rather than noise.

Required range: x >= 0
Example:

0