Skip to main content
GET
cURL
List responses include the complete contents of each dictionary, so pages contain at most five dictionaries. Treat nextPageToken as opaque and pass it back unchanged to retrieve the next page.

Authorizations

Authorization
string
header
required

Your authentication credentials. For Basic authentication, send Basic $INWORLD_API_KEY. Use a Standard API key for the target workspace. Voices Read access permits list and get; Voices Write access permits all five methods.

Path Parameters

workspaceId
string
required

ID of the workspace that owns the dictionary. It must match a workspace accessible to the API key.

Required string length: 1 - 61
Pattern: ^[a-z0-9_-]+$
Example:

"my-workspace"

Query Parameters

pageSize
integer<int32>
default:5

Maximum number of dictionaries to return. Omit or set to 0 to use the default of 5. Values above 5 are reduced to 5; negative values are rejected.

Required range: x >= 0
pageToken
string

Opaque token returned as nextPageToken by the preceding list request. Keep the workspace unchanged when continuing a page sequence.

Response

A page of complete pronunciation dictionaries.

pronunciationDictionaries
object[]
required

Named dictionaries in stable service-defined order, including their complete contents.

nextPageToken
string
required

Opaque token for the next page, or an empty string when this is the final page.