Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Body

application/json
providerVoiceId
string
required

The provider voice id to add, as returned by the search.

Minimum string length: 1
Example:

"EXAVITQu4vr4xnSDxMaL"

displayName
string

What to call this voice in the picker. Defaults to the provider's own name.

Required string length: 1 - 200
Example:

"Sarah (warm)"

Response

Voice added. The full library is returned.

success
boolean
required
voices
object[]
required
used
integer
required

Voices currently added.

Required range: x >= 0
Example:

1

limit
integer | null
required

How many voices this account may add. Null means unlimited.

Required range: x >= 0
Example:

5

remaining
integer | null
required

Voices still addable. Null whenever limit is null: an unlimited allowance has no remainder, and reporting a number here would be inventing one.

Required range: x >= 0
Example:

4