> ## 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.

# List Versions

> List the published versions of a pronunciation dictionary



## OpenAPI

````yaml get /v1/pronunciation-dictionaries/{dictionary_id}/versions
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}/versions:
    get:
      tags:
        - Pronunciation Dictionaries
      summary: List versions
      description: >-
        List the dictionary's published versions, newest first. Archived
        versions are excluded. Paginate with `cursor` (follow `next_cursor`
        while `has_more` is true) or with `page` for offset pagination with a
        `total` count — the two are mutually exclusive.
      parameters:
        - in: path
          name: dictionary_id
          description: ''
          required: true
          schema:
            title: Dictionary Id
            type: string
          deprecated: false
        - in: query
          name: cursor
          description: Opaque cursor from a previous `next_cursor`.
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Cursor
          deprecated: false
        - in: query
          name: page
          description: 1-based page number; mutually exclusive with cursor.
          required: false
          schema:
            anyOf:
              - minimum: 1
                type: integer
              - type: 'null'
            default: null
            title: Page
          deprecated: false
        - in: query
          name: include_total
          description: Also count the filtered set on the cursor path.
          required: false
          schema:
            default: false
            title: Include Total
            type: boolean
          deprecated: false
        - in: query
          name: page_size
          description: Rows per page (1-100, default 30).
          required: false
          schema:
            default: 30
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
          deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                description: One page of pronunciation-dictionary versions.
                properties:
                  versions:
                    description: Versions in this page, newest published first.
                    items:
                      $ref: >-
                        #/components/schemas/PronunciationDictionaryV1VersionEntity
                    title: Versions
                    type: array
                  has_more:
                    description: Whether another page exists after this one.
                    title: Has More
                    type: boolean
                  next_cursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    description: >-
                      Opaque cursor for the next page; pass it as `cursor`. Null
                      when there is no next page.
                    title: Next Cursor
                  total:
                    anyOf:
                      - type: integer
                      - type: 'null'
                    default: null
                    description: >-
                      Rows matching the filters across all pages. Always set in
                      page mode; set on the cursor path only with
                      `include_total=true`.
                    examples:
                      - 2
                    title: Total
                required:
                  - versions
                  - has_more
                type: object
        '400':
          description: Bad request syntax or unsupported method
          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
        '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
        '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:
    PronunciationDictionaryV1VersionEntity:
      description: A published, immutable snapshot of a dictionary.
      properties:
        id:
          description: Stable version identifier.
          examples:
            - 1c3e5a7b9d0f4a2c8e6b4d1f3a5c7e9b
          title: Id
          type: string
        dictionary_id:
          description: Dictionary this version belongs to.
          examples:
            - 9b2f5c0d4e6a4f4c8a1d3e5f7a9b0c2d
          title: Dictionary Id
          type: string
        description:
          description: Version note entered when publishing.
          examples:
            - Add the new product names
          title: Description
          type: string
        version_number:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: >-
            Monotonic version number within the dictionary. Null only for
            versions published before version numbers existed.
          examples:
            - 3
          title: Version Number
        added_count:
          default: 0
          description: Rules added relative to the previous version.
          examples:
            - 2
          title: Added Count
          type: integer
        removed_count:
          default: 0
          description: Rules removed relative to the previous version.
          examples:
            - 0
          title: Removed Count
          type: integer
        changed_count:
          default: 0
          description: Rules whose key, value, type or case sensitivity changed.
          examples:
            - 1
          title: Changed Count
          type: integer
        item_count:
          default: 0
          description: Total number of rules in this version.
          examples:
            - 12
          title: Item Count
          type: integer
        created_at:
          description: Publish time (UTC).
          examples:
            - '2026-11-05T04:02:44Z'
          format: date-time
          title: Created At
          type: string
      required:
        - id
        - dictionary_id
        - description
        - created_at
      title: PronunciationDictionaryV1VersionEntity
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

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