Skip to main content
PATCH
/
voices
/
{id}
Update Voice
curl --request PATCH \
  --url https://api.cartesia.ai/voices/{id} \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "id": "<string>",
  "user_id": "<string>",
  "is_public": true,
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "embedding": [
    123
  ],
  "language": "en"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
Cartesia-Version
enum<string>
required

API version header. Must be set to the API version, e.g. '2024-06-10'.

Available options:
2024-06-10,
2024-11-13,
2025-04-16
Example:

"2024-06-10"

Path Parameters

​
id
string
required

The ID of the voice.

Body

application/json
​
name
string
required

The name of the voice.

​
description
string
required

The description of the voice.

Response

200 - application/json
​
id
string
required

The ID of the voice.

​
is_public
boolean
required

Whether the voice is publicly accessible.

​
name
string
required

The name of the voice.

​
description
string
required

The description of the voice.

​
created_at
string<date-time>
required

The date and time the voice was created.

​
embedding
number[]
required

A 192-dimensional vector (i.e. a list of 192 numbers) that represents the voice.

​
language
enum<string>
required

The language that the given voice should speak the transcript in.

Options: English (en), French (fr), German (de), Spanish (es), Portuguese (pt), Chinese (zh), Japanese (ja), Hindi (hi), Italian (it), Korean (ko), Dutch (nl), Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).

Available options:
en,
fr,
de,
es,
pt,
zh,
ja,
hi,
it,
ko,
nl,
pl,
ru,
sv,
tr
​
user_id
string | null

The ID of the user who owns the voice.

⌘I