Skip to main content
POST
cURL
The service assigns the dictionary ID. Keep the returned name as the stable resource identifier and the returned etag for subsequent updates or deletion.
Every entry is validated before the dictionary is committed. An invalid entry, an entry that duplicates another entry after language-aware lexical matching, or a dictionary that exceeds a limit causes the complete request to fail.
Create has no idempotency key. If the connection fails before you receive a response, do not retry blindly: the service might have committed the dictionary. List the workspace’s dictionaries and reconcile the result first, or a retry can create a duplicate resource.

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"

Body

application/json
displayName
string
required

Non-blank human-readable dictionary name, containing at most 64 Unicode code points.

Required string length: 1 - 64
Example:

"Product names"

pronunciations
object[]

Complete dictionary contents. A dictionary can contain up to 1,000 entries and must remain within the 512 KiB encoded dictionary limit. Entries must be unique after language-aware lexical canonicalization.

Maximum array length: 1000

Response

The dictionary was created.

A workspace-owned named pronunciation dictionary with its complete contents.

name
string
required
read-only

Service-assigned resource name in the form workspaces/{workspace}/pronunciationDictionaries/{uuid}.

Example:

"workspaces/my-workspace/pronunciationDictionaries/2d470a1e-0262-4f22-9b46-5353d454d988"

displayName
string
required

Non-blank human-readable dictionary name, containing at most 64 Unicode code points.

Required string length: 1 - 64
Example:

"Product names"

pronunciations
object[]
required

Complete dictionary contents. A dictionary can contain up to 1,000 entries and must remain within the 512 KiB encoded dictionary limit. Entries must be unique after language-aware lexical canonicalization.

Maximum array length: 1000
etag
string
required

Optimistic-concurrency token. Include the current value when updating or deleting the dictionary.

createTime
string<date-time>
required
read-only

Time at which the dictionary was created.

updateTime
string<date-time>
required
read-only

Time at which the dictionary's metadata or contents last changed.