v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Pronunciation Dictionaries

Create a pronunciation dictionary

Create a new pronunciation dictionary for the authenticated organization. Each dictionary contains a list of items that control how specific words are spoken. Items can be alias type (text replacement) or phoneme type (IPA pronunciation notation).

As an alternative to providing items directly as JSON, you can upload a dictionary file (PLS/XML or plain text format, max 1MB) using multipart/form-data. PLS files use the standard W3C Pronunciation Lexicon Specification XML format. Text files use a line-based format: word=alias for aliases, word:/phoneme/ for IPA phonemes.

Limits:

Maximum 50 dictionaries per organization
Maximum 100 items per dictionary
Text: max 200 characters
Alias/phoneme value: max 500 characters
File upload: max 1MB (1,048,576 bytes)

post/pronunciation_dicts

Request body

namestring required

Human-readable name. Must be unique within the organization.

Example request

{
  "items": [
    {
      "alias": "tel-nicks",
      "text": "Telnyx",
      "type": "alias"
    }
  ],
  "name": "Brand Names"
}

Response

Pronunciation dictionary created successfully.

Example response

{
  "data": {
    "created_at": "2026-03-25T12:00:00.000Z",
    "id": "c215a3e1-be41-4701-97e8-1d3c22f9a5b7",
    "items": [
      {
        "alias": "tel-nicks",
        "text": "Telnyx",
        "type": "alias"
      }
    ],
    "name": "Brand Names",
    "record_type": "pronunciation_dict",
    "updated_at": "2026-03-25T12:00:00.000Z",
    "version": 1
  }
}