Skip to main content
PATCH
/
voices
/
{id}
Update Voice
curl --request PATCH \
  --url https://api.cartesia.ai/voices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "gender": "masculine"
}
'
{
  "id": "<string>",
  "is_owner": true,
  "is_public": true,
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "language": "en",
  "gender": "masculine",
  "is_starred": true
}

Authorizations

​
Authorization
string
header
required

Cartesia API key

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:

"2025-04-16"

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.

​
gender
enum<string> | null
Available options:
masculine,
feminine,
gender_neutral

Response

200 - application/json
​
id
string
required

The ID of the voice.

​
is_owner
boolean
required

Whether the current user is the owner 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.

​
language
enum<string>
required

The language that the given voice should speak the transcript in. For valid options, see Models.

Available options:
en,
fr,
de,
es,
pt,
zh,
ja,
hi,
it,
ko,
nl,
pl,
ru,
sv,
tr,
tl,
bg,
ro,
ar,
cs,
el,
fi,
hr,
ms,
sk,
da,
ta,
uk,
hu,
no,
vi,
bn,
th,
he,
ka,
id,
te,
gu,
kn,
ml,
mr,
pa
​
gender
enum<string> | null

The gender of the voice, if specified.

Available options:
masculine,
feminine,
gender_neutral
​
is_starred
boolean | null

Whether the current user has starred the voice. Only included when expand includes is_starred.