TAtavus
Pronunciation Dictionaries

Update Pronunciation Dictionary

Changed on

Update a pronunciation dictionary's name or rules using JSON Patch format (RFC 6902). Supported mutable fields are name and rules.

patch/v2/pronunciation-dictionaries/{dictionary_id}

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/pronunciation-dictionaries/{dictionary_id}
  • Auth
    API key in header x-api-key

Path parameters

dictionary_idstring required

The unique identifier of the pronunciation dictionary.

Request body

op'add' | 'remove' | 'replace' | 'copy' | 'move' | 'test' required

The operation to perform. Must be one of: add, remove, replace, copy, move, test

pathstring required

A JSON Pointer string that references a location within the target document where the operation is performed. Supported paths: /name, /rules.

valueunknown

Example request

[
  {
    "op": "replace",
    "path": "/name"
  }
]

Response

Pronunciation dictionary updated successfully

pronunciation_dictionary_idstring

Unique identifier for the pronunciation dictionary.

namestring

Name of the pronunciation dictionary.

rules_countinteger

Number of rules in the dictionary.

created_atstring

ISO 8601 timestamp of when the dictionary was created.

updated_atstring

ISO 8601 timestamp of when the dictionary was last updated.

Example response

{
  "pronunciation_dictionary_id": "pd_abc123def456gh",
  "name": "Updated Brand Terms",
  "rules": [
    {
      "text": "Tavus",
      "pronunciation": "TAH-vus",
      "type": "alias",
      "word_boundaries": true
    }
  ],
  "rules_count": 1,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T12:00:00Z"
}

Changes

  • 932c24e63be2Revision changes
    • info

      the endpoint scheme security apiKey was added to the API

    • info

      added the media type application/json to the request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status