cURL
curl --get \
"https://api.inworld.ai/pronunciations/v1/workspaces/${INWORLD_WORKSPACE_ID}/pronunciationDictionaries" \
--header "Authorization: Basic ${INWORLD_API_KEY}" \
--data-urlencode "pageSize=5"import os
import requests
workspace_id = os.environ["INWORLD_WORKSPACE_ID"]
url = (
"https://api.inworld.ai/pronunciations/v1/"
f"workspaces/{workspace_id}/pronunciationDictionaries"
)
response = requests.get(
url,
headers={"Authorization": f"Basic {os.environ['INWORLD_API_KEY']}"},
params={"pageSize": 5},
)
response.raise_for_status()
print(response.json())const workspaceId = process.env.INWORLD_WORKSPACE_ID;
const url = new URL(
`https://api.inworld.ai/pronunciations/v1/workspaces/${workspaceId}/pronunciationDictionaries`,
);
url.searchParams.set('pageSize', '5');
const response = await fetch(url, {
headers: { Authorization: `Basic ${process.env.INWORLD_API_KEY}` },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());{
"pronunciationDictionaries": [
{
"name": "workspaces/my-workspace/pronunciationDictionaries/2d470a1e-0262-4f22-9b46-5353d454d988",
"displayName": "Product names",
"pronunciations": [
{
"displayHeadword": "Hello",
"languageCode": "en-US",
"phoneSymbols": [
"h",
"ə",
"l",
"oʊ"
]
}
],
"etag": "tLKwUsvfq4TjPZQYhA9Dg3pM",
"createTime": "2026-08-14T18:22:31.145Z",
"updateTime": "2026-08-14T18:22:31.145Z"
}
],
"nextPageToken": "eyJkIjoiLi4uIn0"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Pronunciation dictionaries
List pronunciation dictionaries
List named pronunciation dictionaries and their complete contents.
GET
/
pronunciations
/
v1
/
workspaces
/
{workspaceId}
/
pronunciationDictionaries
cURL
curl --get \
"https://api.inworld.ai/pronunciations/v1/workspaces/${INWORLD_WORKSPACE_ID}/pronunciationDictionaries" \
--header "Authorization: Basic ${INWORLD_API_KEY}" \
--data-urlencode "pageSize=5"import os
import requests
workspace_id = os.environ["INWORLD_WORKSPACE_ID"]
url = (
"https://api.inworld.ai/pronunciations/v1/"
f"workspaces/{workspace_id}/pronunciationDictionaries"
)
response = requests.get(
url,
headers={"Authorization": f"Basic {os.environ['INWORLD_API_KEY']}"},
params={"pageSize": 5},
)
response.raise_for_status()
print(response.json())const workspaceId = process.env.INWORLD_WORKSPACE_ID;
const url = new URL(
`https://api.inworld.ai/pronunciations/v1/workspaces/${workspaceId}/pronunciationDictionaries`,
);
url.searchParams.set('pageSize', '5');
const response = await fetch(url, {
headers: { Authorization: `Basic ${process.env.INWORLD_API_KEY}` },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());{
"pronunciationDictionaries": [
{
"name": "workspaces/my-workspace/pronunciationDictionaries/2d470a1e-0262-4f22-9b46-5353d454d988",
"displayName": "Product names",
"pronunciations": [
{
"displayHeadword": "Hello",
"languageCode": "en-US",
"phoneSymbols": [
"h",
"ə",
"l",
"oʊ"
]
}
],
"etag": "tLKwUsvfq4TjPZQYhA9Dg3pM",
"createTime": "2026-08-14T18:22:31.145Z",
"updateTime": "2026-08-14T18:22:31.145Z"
}
],
"nextPageToken": "eyJkIjoiLi4uIn0"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}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
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
ID of the workspace that owns the dictionary. It must match a workspace accessible to the API key.
Required string length:
1 - 61Pattern:
^[a-z0-9_-]+$Example:
"my-workspace"
Query Parameters
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 >= 0Opaque 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.