PUT
/
v1
/
ai
/
voice
/
{id}
curl --request PUT \
  --url https://api.lmnt.com/v1/ai/voice/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '{
  "description": "<string>",
  "gender": "<string>",
  "name": "<string>",
  "starred": true,
  "unfreeze": true
}'
{
  "voice": {
    "description": "<string>",
    "gender": "<string>",
    "id": "<string>",
    "name": "<string>",
    "owner": "system",
    "starred": true,
    "state": "<string>",
    "type": "instant"
  }
}

Got an error that your voice was frozen?

We are constantly improving and releasing our speech models. Professional voices that are not being used will not be upgraded automatically and will enter a frozen state.

Make a request to this endpoint with "unfreeze": true to upgrade it to the latest model.

Instant voices always use the latest model and are never frozen.

Headers

X-API-Key
string
required

Your API key; get it from your LMNT account page.

Path Parameters

id
string
required

The id of the voice to update, which can be retrieved by a call to List voices.

Body

application/json
description
string

A description of this voice.

gender
string

A tag describing the gender of this voice, e.g. male, female, nonbinary.

name
string

The display name for this voice.

starred
boolean

If true, adds this voice to your starred list.

unfreeze
boolean

If true, unfreezes this voice and upgrades it to the latest model.

Response

200 - application/json
voice
object
required

Voice details

Voice infoDelete voice