Sign in

v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB
PronunciationDicts

Update a pronunciation dictionary

patch/pronunciation-dicts/{id}

Path parameters

idstring required

ID of the pronunciation dictionary to update

Headers

Cartesia-Version'2026-03-01' date required
Example:2026-03-01

API version header.

Request body

namestring

New name for the pronunciation dictionary

descriptionstring

New description for the pronunciation dictionary

Response

idstring required

Unique identifier for the pronunciation dictionary

namestring required

Name of the pronunciation dictionary

descriptionstring required

Description of the pronunciation dictionary

is_ownerboolean required

Whether your organization owns the pronunciation dictionary.

pinnedboolean required

Whether this dictionary is pinned for the user

created_atstring required

ISO 8601 timestamp of when the dictionary was created

owner_idstring required

ID of the user who owns this dictionary. Use is_owner instead.

Example response

{
  "id": "pdict_123",
  "name": "Acme",
  "description": "An example dictionary",
  "is_owner": true,
  "pinned": false,
  "access": {
    "type": "private",
    "visibility": "owner"
  },
  "items": [
    {
      "text": "acme",
      "alias": "<<ˈ|æ|k|m|i>>",
      "pronunciation": "<<ˈ|æ|k|m|i>>"
    }
  ],
  "created_at": "2025-10-27T14:54:26.68581Z",
  "owner_id": "org_123"
}