CreatePronunciationDictRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-create-pronunciation-dict-request-schema.json",
  "title": "CreatePronunciationDictRequest",
  "description": "Request body for creating a pronunciation dictionary.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-pronunciation-dictionaries-api-openapi.yml#/components/schemas/CreatePronunciationDictRequest",
  "properties": {
    "items": {
      "description": "List of pronunciation items (alias or phoneme type). At least one item is required.",
      "items": {
        "$ref": "#/$defs/PronunciationDictItem"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array"
    },
    "name": {
      "description": "Human-readable name. Must be unique within the organization.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "items"
  ],
  "type": "object",
  "$defs": {
    "PronunciationDictAliasItem": {
      "additionalProperties": false,
      "description": "An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.",
      "properties": {
        "alias": {
          "description": "The replacement text that will be spoken instead.",
          "maxLength": 500,
          "minLength": 1,
          "type": "string"
        },
        "text": {
          "description": "The text to match in the input. Case-insensitive matching is used during synthesis.",
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        },
        "type": {
          "description": "The item type.",
          "enum": [
            "alias"
          ],
          "type": "string"
        }
      },
      "required": [
        "text",
        "type",
        "alias"
      ],
      "type": "object"
    },
    "PronunciationDictItem": {
      "description": "A single pronunciation dictionary item. Use type 'alias' to replace matched text with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA notation.",
      "oneOf": [
        {
          "$ref": "#/$defs/PronunciationDictAliasItem"
        },
        {
          "$ref": "#/$defs/PronunciationDictPhonemeItem"
        }
      ]
    },
    "PronunciationDictPhonemeItem": {
      "additionalProperties": false,
      "description": "A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.",
      "properties": {
        "alphabet": {
          "description": "The phonetic alphabet used for the phoneme notation.",
          "enum": [
            "ipa"
          ],
          "type": "string"
        },
        "phoneme": {
          "description": "The phoneme notation representing the desired pronunciation.",
          "maxLength": 500,
          "minLength": 1,
          "type": "string"
        },
        "text": {
          "description": "The text to match in the input. Case-insensitive matching is used during synthesis.",
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        },
        "type": {
          "description": "The item type.",
          "enum": [
            "phoneme"
          ],
          "type": "string"
        }
      },
      "required": [
        "text",
        "type",
        "phoneme",
        "alphabet"
      ],
      "type": "object"
    }
  }
}