> ## Documentation Index
> Fetch the complete documentation index at: https://anam.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# get pronunciation dictionary

> Returns a pronunciation dictionary with its entries and current revision.



## OpenAPI

````yaml https://api.anam.ai/swagger.json get /v1/pronunciation-dictionaries/{id}
openapi: 3.1.0
info:
  title: Anam AI API
  version: '1.0'
servers:
  - url: https://api.anam.ai
    description: Anam API
security:
  - BearerAuth: []
tags:
  - name: Sessions
  - name: Avatar Videos
  - name: Meetings
  - name: Personas
  - name: Avatars
  - name: Voices
  - name: Pronunciation Dictionaries
  - name: LLMs
  - name: Knowledge
  - name: Tools
  - name: Share Links
  - name: Engine
paths:
  /v1/pronunciation-dictionaries/{id}:
    get:
      tags:
        - Pronunciation Dictionaries
      summary: get pronunciation dictionary
      description: >-
        Returns a pronunciation dictionary with its entries and current
        revision.
      operationId: getPronunciationDictionary
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          description: Pronunciation dictionary ID
      responses:
        '200':
          description: Successfully retrieved pronunciation dictionary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PronunciationDictionary'
              examples:
                default:
                  $ref: '#/components/examples/PronunciationDictionaryResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
        '403':
          description: Forbidden - API key lacks read access to pronunciation dictionaries
        '404':
          description: >-
            Not Found - No pronunciation dictionary with this ID in your
            organization, or it was archived
        '500':
          description: Server error
components:
  schemas:
    PronunciationDictionary:
      description: >
        A pronunciation dictionary and its entries. Saves are live: sessions
        that start after a save use the saved entries, and running sessions keep
        the entries they started with.
      allOf:
        - $ref: '#/components/schemas/PronunciationDictionarySummary'
        - type: object
          properties:
            entries:
              type: array
              items:
                $ref: '#/components/schemas/PronunciationEntry'
    PronunciationDictionarySummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Pronunciation dictionary ID. Pass it as
            `voiceGenerationOptions.pronunciationDictionaryId` when creating a
            session token.
          example: 4f600129-13cf-4bfa-909a-2f4c31467f43
        name:
          type: string
          description: Display name
          example: Brand names
        revision:
          type: integer
          minimum: 1
          description: >-
            Starts at 1 and increases with every save. Send it as
            `expectedRevision` to reject a write if someone else saved first.
          example: 1
        createdAt:
          type: string
          format: date-time
          description: When the dictionary was created
        updatedAt:
          type: string
          format: date-time
          description: When the dictionary was last saved
    PronunciationEntry:
      type: object
      additionalProperties: false
      required:
        - text
        - pronunciation
      description: >
        One word or phrase and how to say it. The persona speaks the
        pronunciation in place of the text; captions and transcripts keep the
        original text.


        Text and pronunciation must not be blank or contain `[` or `]`. Two
        entries can't have the same text (ignoring case and spacing) unless both
        set `caseSensitive` and differ only in case.
      properties:
        text:
          type: string
          maxLength: 100
          description: Word or phrase to replace, at most 100 Unicode characters.
          example: Anam
        kind:
          type: string
          enum:
            - sounds_like
            - ipa
          default: sounds_like
          description: >
            - `sounds_like`: `pronunciation` is a respelling, such as `annum`.
            Works with every voice.

            - `ipa`: `pronunciation` is Cartesia IPA markup, such as
            `<<ˈ|ɑ|n|ə|m>>`. Voices whose model reads IPA (Cartesia Sonic 3,
            ElevenLabs v3 and v4) speak it; other voices speak `soundsLike`, or
            leave the text unchanged without it.
          example: sounds_like
        pronunciation:
          type: string
          maxLength: 200
          description: >-
            How to say the text, at most 200 Unicode characters. A sounds-like
            respelling can't contain `<<` or `>>`.
          example: annum
        soundsLike:
          type: string
          maxLength: 200
          description: >-
            IPA entries only. Respelling spoken by voices whose model can't read
            IPA.
          example: annum
        caseSensitive:
          type: boolean
          default: false
          description: Match the text only with the same capitalization.
          example: false
  examples:
    PronunciationDictionaryResponse:
      summary: A pronunciation dictionary
      value:
        id: 4f600129-13cf-4bfa-909a-2f4c31467f43
        name: Brand names
        revision: 1
        createdAt: '2026-10-11T09:00:00.000Z'
        updatedAt: '2026-10-11T09:00:00.000Z'
        entries:
          - text: Anam
            kind: sounds_like
            pronunciation: annum
            caseSensitive: false
          - text: SQL
            kind: sounds_like
            pronunciation: sequel
            caseSensitive: true
          - text: Zorvex
            kind: ipa
            pronunciation: <<ˈ|z|ɔ|ɹ|v|ɛ|k|s>>
            soundsLike: zor vex
            caseSensitive: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.