Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
default:$CARTESIA_API_KEY
required

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

Headers

Cartesia-Version
enum<string>
default:2026-08-14
required

API version header.

Available options:
2026-08-14
Example:

"2026-08-14"

Path Parameters

id
string
required

ID of the pronunciation dictionary to update

Body

application/json

Request to update an existing pronunciation dictionary

name
string

New name for the pronunciation dictionary

description
string

New description for the pronunciation dictionary

items
PronunciationDictItem · object[] | null

Updated list of pronunciation mappings

access

Controls who can access this resource. Prefer "public" | "private". Deprecated nested { "type": "public" | "private" } is still accepted.

Available options:
private,
public

Response

200 - application/json

A dictionary of text-to-pronunciation mappings

id
string
required

Unique identifier for the pronunciation dictionary

name
string
required

Name of the pronunciation dictionary

description
string
required

Description of the pronunciation dictionary

is_owner
boolean
required

Whether your organization owns the pronunciation dictionary.

access
enum<string>
required

Who can use the resource. private means only the owner can use the resource. public means everyone can use the resource.

Available options:
private,
public
pinned
boolean
required

Whether this dictionary is pinned for the user

items
PronunciationDictItem · object[]
required

List of text-to-pronunciation mappings

created_at
string
required

ISO 8601 timestamp of when the dictionary was created

visibility
enum<string>
required

When the resource is returned by the list endpoint. owner means the resource appears for the owner only. all means the resource appears for all users.

Available options:
owner,
all