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

# Rename pronunciation dictionary



## OpenAPI

````yaml /docs/openapi.json patch /api/v1/tts/pronunciation-dictionaries/{dictionary_id}
openapi: 3.1.0
info:
  title: Voice AI Developer API
  description: >-
    Generate realistic speech and clone voices. AI voice agents with retrieval
    augmented generation (RAG) and model context protocol (MCP) included.
  version: 1.5.0
  contact: {}
servers:
  - url: https://dev.voice.ai
    description: HTTP API endpoints
security:
  - BearerAuth: []
tags:
  - name: Text To Speech
    description: Text-to-speech endpoints for voice cloning and speech generation.
  - name: Pronunciation Dictionaries
    description: Manage versioned pronunciation dictionaries for TTS and voice agents.
  - name: Agent Management
    description: Create, update, deploy, and manage voice agents.
  - name: Models
    description: Discover supported LLM and TTS model options.
  - name: Agent Connection
    description: Connect to agents and manage active calls.
  - name: Agent Analytics
    description: >-
      Analytics and reporting for agent performance, call history, and
      statistics.
  - name: Agent Knowledge Base
    description: >-
      Manage knowledge bases for retrieval augmented generation (RAG) with your
      agents.
  - name: Phone Number Management
    description: >-
      Search, select, and manage phone numbers from your plan allocation.
      Release numbers to free up slots.
  - name: Managed Tools
    description: >-
      Connect Google Calendar, Sheets, and Gmail to agents and inspect
      connection state.
paths:
  /api/v1/tts/pronunciation-dictionaries/{dictionary_id}:
    patch:
      tags:
        - Pronunciation Dictionaries
      summary: Rename pronunciation dictionary
      operationId: >-
        update_pronunciation_dictionary_api_v1_tts_pronunciation_dictionaries__dictionary_id__patch
      parameters:
        - name: dictionary_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Dictionary Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePronunciationDictionaryRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PronunciationDictionaryDetailResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Pronunciation dictionary not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    UpdatePronunciationDictionaryRequest:
      type: object
      properties:
        name:
          type: string
          title: Name
          description: Updated dictionary display name
      required:
        - name
      title: UpdatePronunciationDictionaryRequest
    PronunciationDictionaryDetailResponse:
      allOf:
        - $ref: '#/components/schemas/PronunciationDictionarySummaryResponse'
        - type: object
          properties:
            rules:
              type: array
              items:
                $ref: '#/components/schemas/PronunciationRuleResponse'
              title: Rules
              description: Rules in the active version
              default: []
            versions:
              type: array
              items:
                $ref: >-
                  #/components/schemas/PronunciationDictionaryVersionSummaryResponse
              title: Versions
              description: Version history
              default: []
          required:
            - rules
            - versions
      title: PronunciationDictionaryDetailResponse
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: Error message
        detail:
          type: string
          title: Detail
          description: Detailed error information
          nullable: true
        code:
          type: string
          title: Code
          description: Error code
          nullable: true
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PronunciationDictionarySummaryResponse:
      type: object
      properties:
        id:
          type: string
          title: Id
          description: Dictionary identifier
        name:
          type: string
          title: Name
          description: Dictionary display name
        language:
          type: string
          title: Language
          description: Dictionary language code
        current_version:
          type: integer
          title: Current Version
          description: Current active version number
        created_at_unix:
          type: integer
          title: Created At Unix
          description: Creation timestamp in unix seconds
        updated_at_unix:
          type: integer
          title: Updated At Unix
          description: Last update timestamp in unix seconds
      required:
        - id
        - name
        - language
        - current_version
        - created_at_unix
        - updated_at_unix
      title: PronunciationDictionarySummaryResponse
    PronunciationRuleResponse:
      type: object
      properties:
        id:
          type: string
          title: Id
          description: Stable rule identifier
        word:
          type: string
          title: Word
          description: Word or phrase to match
        replacement:
          type: string
          title: Replacement
          description: Replacement pronunciation text
        ipa:
          anyOf:
            - type: string
            - type: 'null'
          title: Ipa
          description: Optional phonetic pronunciation string
        case_sensitive:
          type: boolean
          title: Case Sensitive
          description: Whether matching is case sensitive
          default: true
      required:
        - id
        - word
        - replacement
      title: PronunciationRuleResponse
    PronunciationDictionaryVersionSummaryResponse:
      type: object
      properties:
        version:
          type: integer
          title: Version
          description: Dictionary version number
        created_at_unix:
          type: integer
          title: Created At Unix
          description: Version creation timestamp in unix seconds
      required:
        - version
        - created_at_unix
      title: PronunciationDictionaryVersionSummaryResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Use your API key as the bearer token.
        Format: Authorization: Bearer <your-api-key>

````