Get Pronunciation Dictionaries

Get a list of the pronunciation dictionaries you have access to and their metadata

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

page_sizeinteger

How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30.

sort'creation_time_unix' | 'name' nullable

Which field to sort by, one of 'created_at_unix' or 'name'.

Example:creation_time_unix

Which field to sort by, one of 'created_at_unix' or 'name'.

sort_directionstring nullable

Which direction to sort the voices in. 'ascending' or 'descending'.

Example:descending

Which direction to sort the voices in. 'ascending' or 'descending'.

include_archivedboolean

Whether to include archived pronunciation dictionaries in the response.

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

next_cursorstring nullable

The next cursor to use for pagination.

has_moreboolean required

Whether there are more pronunciation dictionaries to fetch.

Example response

{
  "has_more": false,
  "next_cursor": "5xM3yVvZQKV0EfqQpLr2",
  "pronunciation_dictionaries": [
    {
      "created_by": "ar6633Es2kUjFXBdR1iVc9ztsXl1",
      "creation_time_unix": 1714156800,
      "description": "This is a test dictionary",
      "id": "5xM3yVvZQKV0EfqQpLrJ",
      "latest_version_id": "5xM3yVvZQKV0EfqQpLr2",
      "latest_version_rules_num": 2,
      "name": "My Dictionary",
      "permission_on_resource": "admin"
    }
  ]
}

v5

Get Pronunciation Dictionaries

Query parameters

Headers

Response

Example response