Skip to main content
POST
/
v2
/
pronunciation-dictionaries
Create Pronunciation Dictionary
curl --request POST \
  --url https://tavusapi.com/v2/pronunciation-dictionaries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Brand Terms",
  "rules": [
    {
      "text": "Tavus",
      "pronunciation": "TAH-vus",
      "type": "alias"
    }
  ]
}
'
{
  "pronunciation_dictionary_id": "pd_abc123def456gh",
  "name": "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-15T10:30:00Z"
}
For a guide on rule types and how to attach dictionaries to personas, see Pronunciation dictionaries.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

Name of the pronunciation dictionary. Max 255 characters.

Example:

"Brand Terms"

​
rules
object[]

List of pronunciation rules. Duplicate text values are not allowed.

Example:
[
  {
    "text": "Tavus",
    "pronunciation": "TAH-vus",
    "type": "alias"
  }
]

Response

Pronunciation dictionary created successfully

​
pronunciation_dictionary_id
string

Unique identifier for the pronunciation dictionary.

Example:

"pd_abc123def456gh"

​
name
string

Name of the pronunciation dictionary.

Example:

"Brand Terms"

​
rules
object[]

List of pronunciation rules.

​
rules_count
integer

Number of rules in the dictionary.

Example:

1

​
created_at
string

ISO 8601 timestamp of when the dictionary was created.

Example:

"2025-01-15T10:30:00Z"

​
updated_at
string

ISO 8601 timestamp of when the dictionary was last updated.

Example:

"2025-01-15T10:30:00Z"