Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
studio

Create Pronunciation Dictionaries

Create a set of pronunciation dictionaries acting on a project. This will automatically mark text within this project as requiring reconverting where the new dictionary would apply or the old one no longer does.

post/v1/studio/projects/{project_id}/pronunciation-dictionaries

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

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

invalidate_affected_textboolean

This will automatically mark text in this project for reconversion when the new dictionary applies or the old one no longer does.

Example request

{
  "pronunciation_dictionary_locators": [
    "{\"pronunciation_dictionary_id\": \"21m00Tcm4TlvDq8ikWAM\", \"version_id\": \"BdF0s0aZ3oFoKnDYdTox\"}"
  ]
}

Response

Successful Response

statusstring required

The status of the create pronunciation dictionary request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}