ANanam
Pronunciation Dictionaries

get pronunciation dictionary

Changed on

Returns a pronunciation dictionary with its entries and current revision.

get/v1/pronunciation-dictionaries/{id}

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/pronunciation-dictionaries/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Pronunciation dictionary ID

Response

Successfully retrieved pronunciation dictionary

idstring uuid

Pronunciation dictionary ID. Pass it as voiceGenerationOptions.pronunciationDictionaryId when creating a session token.

namestring

Display name

revisioninteger

Starts at 1 and increases with every save. Send it as expectedRevision to reject a write if someone else saved first.

createdAtstring date-time

When the dictionary was created

updatedAtstring date-time

When the dictionary was last saved

Example response

{
  "id": "4f600129-13cf-4bfa-909a-2f4c31467f43",
  "name": "Brand names",
  "revision": 1,
  "entries": [
    {
      "text": "Anam",
      "kind": "sounds_like",
      "pronunciation": "annum",
      "soundsLike": "annum"
    }
  ]
}

Changes