ADMINISTRATIONPronunciation Dictionaries

Create a pronunciation dictionary from rules

Creates a new pronunciation dictionary from provided rules.

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
ruleslist of objectsRequired

List of pronunciation rules. Rule can be either: an alias rule: {‘string_to_replace’: ‘a’, ‘type’: ‘alias’, ‘alias’: ‘b’, } or a phoneme rule: {‘string_to_replace’: ‘a’, ‘type’: ‘phoneme’, ‘phoneme’: ‘b’, ‘alphabet’: ‘ipa’ }

namestringRequired
The name of the pronunciation dictionary, used for identification only.
descriptionstringOptional
A description of the pronunciation dictionary, used for identification only.
workspace_accessenumOptional
Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
Allowed values:

Response

Successful Response
idstring
The ID of the created pronunciation dictionary.
namestring
The name of the created pronunciation dictionary.
created_bystring
The user ID of the creator of the pronunciation dictionary.
creation_time_unixinteger
The creation time of the pronunciation dictionary in Unix timestamp.
version_idstring
The ID of the created pronunciation dictionary version.
version_rules_numinteger
The number of rules in the version of the pronunciation dictionary.
descriptionstring or null
The description of the pronunciation dictionary.
permission_on_resourceenum or null
The permission on the resource of the pronunciation dictionary.
Allowed values:

Errors