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

# Update Dictionary

> Rename a pronunciation dictionary or change its description

This changes only the name and description. To change rules, [publish a new version](https://docs.fish.audio/api-reference/endpoint/pronunciation-dictionary/create-version.md).


## OpenAPI

````yaml patch /v1/pronunciation-dictionaries/{dictionary_id}
openapi: 3.1.0
info:
  title: FishAudio OpenAPI
  version: '1'
servers:
  - description: Fish Audio API
    url: https://api.fish.audio
security: []
tags: []
paths:
  /v1/pronunciation-dictionaries/{dictionary_id}:
    patch:
      tags:
        - Pronunciation Dictionaries
      summary: Update a pronunciation dictionary
      description: >-
        Change the dictionary's name or description. Rules live in published
        versions and are not editable in place.
      parameters:
        - in: path
          name: dictionary_id
          description: ''
          required: true
          schema:
            title: Dictionary Id
            type: string
          deprecated: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PronunciationDictionaryUpdatePayload'
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                description: A pronunciation dictionary owned by the caller's team.
                properties:
                  id:
                    description: Stable dictionary identifier.
                    examples:
                      - 9b2f5c0d4e6a4f4c8a1d3e5f7a9b0c2d
                    title: Id
                    type: string
                  name:
                    description: Display name for the dictionary.
                    examples:
                      - Product names
                    title: Name
                    type: string
                  description:
                    description: Free-form description shown in the web app.
                    examples:
                      - Brand and product pronunciations for support scripts.
                    title: Description
                    type: string
                  latest_version_id:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    description: >-
                      Identifier of the latest published version, or null when
                      the dictionary has never been published.
                    examples:
                      - 1c3e5a7b9d0f4a2c8e6b4d1f3a5c7e9b
                    title: Latest Version Id
                  item_count:
                    default: 0
                    description: Number of rules in the latest published version.
                    examples:
                      - 12
                    title: Item Count
                    type: integer
                  preview_voice_id:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    description: >-
                      Voice model last used by the dictionary's preview player,
                      or null when it was never previewed.
                    examples:
                      - b1a2c3d4e5f60718293a4b5c6d7e8f90
                    title: Preview Voice Id
                  preview_model:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    description: >-
                      TTS model last used by the dictionary's preview player, or
                      null when it was never previewed.
                    examples:
                      - s2-pro
                    title: Preview Model
                  created_at:
                    description: Creation time (UTC).
                    examples:
                      - '2026-11-05T03:21:09Z'
                    format: date-time
                    title: Created At
                    type: string
                  updated_at:
                    description: Last content or metadata update time (UTC).
                    examples:
                      - '2026-11-05T04:02:44Z'
                    format: date-time
                    title: Updated At
                    type: string
                required:
                  - id
                  - name
                  - description
                  - created_at
                  - updated_at
                type: object
        '401':
          description: No permission -- see authorization schemes
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
        '403':
          description: Request forbidden -- authorization will not help
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
        '404':
          description: Nothing matches the given URI
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
        '409':
          description: Request conflict
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
        '422':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
        '503':
          description: The server cannot process the request due to a high load
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                  reason:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Reason
                required:
                  - status
                  - message
                type: object
      security:
        - BearerAuth: []
components:
  schemas:
    PronunciationDictionaryUpdatePayload:
      properties:
        name:
          anyOf:
            - maxLength: 128
              minLength: 1
              type: string
            - type: 'null'
          default: null
          description: New display name; omitted or null leaves it unchanged.
          examples:
            - Product names
          title: Name
        description:
          anyOf:
            - maxLength: 1024
              type: string
            - type: 'null'
          default: null
          description: New description; omitted or null leaves it unchanged.
          examples:
            - Brand and product pronunciations for support scripts.
          title: Description
      title: PronunciationDictionaryUpdatePayload
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

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