Pronunciation dictionaries

Delete a pronunciation dictionary

Delete a named pronunciation dictionary and all of its entries.

DEL/pronunciations/v1/workspaces/{workspaceId}/pronunciationDictionaries/{pronunciationDictionaryId}

The request must include the current etag. A stale value returns HTTP 409 Conflict; get the dictionary again before retrying the deletion. Set allowMissing=true to treat an already-absent dictionary as a successful deletion. A non-empty etag is still required.

Authorizations

Authorizationstringrequired

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

workspaceIdstringrequired

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

pronunciationDictionaryIdstringrequired

Service-assigned UUID from the dictionary's resource name.

Query Parameters

etagstringrequired

Current dictionary etag from a get, list, create, or update response.

allowMissingbooleandefault: false

When true, deleting a dictionary that is already absent succeeds. A non-empty etag is still required, but it is not compared when the dictionary is absent.

Delete a pronunciation dictionary

curl --request DELETE \
  "https://api.inworld.ai/pronunciations/v1/workspaces/${INWORLD_WORKSPACE_ID}/pronunciationDictionaries/${PRONUNCIATION_DICTIONARY_ID}?etag=${PRONUNCIATION_DICTIONARY_ETAG}" \
  --header "Authorization: Basic ${INWORLD_API_KEY}"

default_response

{}