{
"pronunciation_dictionary_id": "pd_abc123def456gh",
"name": "Updated Brand Terms",
"rules": [
{
"text": "Tavus",
"pronunciation": "TAH-vus",
"type": "alias",
"case_sensitive": false,
"word_boundaries": true
}
],
"rules_count": 1,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T12:00:00Z"
}{
"error": "Invalid request: duplicate text values in rules"
}{
"message": "Invalid access token"
}{
"message": "Pronunciation dictionary not found"
}{
"message": "Invalid JSON patch format"
}Update Pronunciation Dictionary
Update a pronunciation dictionary’s name or rules using JSON Patch format (RFC 6902). Supported mutable fields are name and rules.
{
"pronunciation_dictionary_id": "pd_abc123def456gh",
"name": "Updated Brand Terms",
"rules": [
{
"text": "Tavus",
"pronunciation": "TAH-vus",
"type": "alias",
"case_sensitive": false,
"word_boundaries": true
}
],
"rules_count": 1,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T12:00:00Z"
}{
"error": "Invalid request: duplicate text values in rules"
}{
"message": "Invalid access token"
}{
"message": "Pronunciation dictionary not found"
}{
"message": "Invalid JSON patch format"
}https://docs.tavus.io/openapi.yaml for the full HTTP API contract.Authorizations
Path Parameters
The unique identifier of the pronunciation dictionary.
Body
Read-only fields like pronunciation_dictionary_id, created_at, and updated_at are silently ignored. If all operations target read-only fields or result in no changes, the endpoint returns 304.
When rules are updated, all PALs referencing this dictionary are automatically updated with the new provider-specific pronunciation data.
Note: Updating rules replaces the entire rules array. There is no way to add or remove individual rules - provide the complete updated list.
For example:
[ { "op": "replace", "path": "/name", "value": "Updated Brand Terms" }, { "op": "replace", "path": "/rules", "value": [ { "text": "Tavus", "pronunciation": "TAH-vus", "type": "alias" } ]} ]
The operation to perform. Must be one of: add, remove, replace, copy, move, test
add, remove, replace, copy, move, test "replace"
A JSON Pointer string that references a location within the target document where the operation is performed. Supported paths: /name, /rules.
"/name"
The value to be used within the operation. Required unless using remove.
Response
Pronunciation dictionary updated successfully
Unique identifier for the pronunciation dictionary.
"pd_abc123def456gh"
Name of the pronunciation dictionary.
"Updated Brand Terms"
List of pronunciation rules.
Show child attributes
Show child attributes
Number of rules in the dictionary.
1
ISO 8601 timestamp of when the dictionary was created.
"2025-01-15T10:30:00Z"
ISO 8601 timestamp of when the dictionary was last updated.
"2025-01-15T12:00:00Z"