Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Pronunciation Dictionary

Set Rules On The Pronunciation Dictionary

Replaces all existing rules on the pronunciation dictionary with the provided ones.

post/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules

Path parameters

pronunciation_dictionary_idstring required

The id of the pronunciation dictionary

Example:21m00Tcm4TlvDq8ikWAM

The id of the pronunciation dictionary

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Example request

{
  "rules": [
    {
      "alias": "tie-land",
      "case_sensitive": true,
      "string_to_replace": "Thailand",
      "type": "alias",
      "word_boundaries": true
    }
  ]
}

Response

Successfully set rules on the pronunciation dictionary

idstring required

The ID of the pronunciation dictionary.

version_idstring required

The version ID of the pronunciation dictionary.

version_rules_numinteger required

The number of rules in the version of the pronunciation dictionary.

Example response

{
  "id": "5xM3yVvZQKV0EfqQpLrJ",
  "version_id": "5xM3yVvZQKV0EfqQpLr2",
  "version_rules_num": 5
}