v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Pronunciation Dictionary

Add A Pronunciation Dictionary

Creates a new pronunciation dictionary from a lexicon .PLS file

post/v1/pronunciation-dictionaries/add-from-file

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.

Response

Successful Response

idstring required

The ID of the created pronunciation dictionary.

namestring required

The name of the created pronunciation dictionary.

created_bystring required

The user ID of the creator of the pronunciation dictionary.

creation_time_unixinteger required

The creation time of the pronunciation dictionary in Unix timestamp.

version_idstring required

The ID of the created pronunciation dictionary version.

version_rules_numinteger required

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

descriptionstring nullable

The description of the pronunciation dictionary.

permission_on_resource'admin' | 'editor' | 'commenter' | 'viewer' nullable required

The permission on the resource of the pronunciation dictionary.

Example response

{
  "created_by": "ar6633Es2kUjFXBdR1iVc9ztsXl1",
  "creation_time_unix": 1714156800,
  "description": "This is a test dictionary",
  "id": "5xM3yVvZQKV0EfqQpLrJ",
  "name": "My Dictionary",
  "permission_on_resource": "admin",
  "version_id": "5xM3yVvZQKV0EfqQpLrJ",
  "version_rules_num": 5
}