Pronunciation Dictionary

Add Rules To The Pronunciation Dictionary

Changed on

Add rules to the pronunciation dictionary. If a rule with the same string_to_replace already exists, it will be replaced.

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules
  • Auth
    none declared

Path parameters

pronunciation_dictionary_idstring required

The id of the pronunciation dictionary

Example:21m00Tcm4TlvDq8ikWAM

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.

Request body

Example request

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

Response

Successful Response

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
}

Changes

  • deb5e58ddddfRevision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

  • 5b595807512cRevision changes
    • info

      api operation id Add_rules_to_the_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id__add_rules_post removed and replaced with add_rules