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

# List replacement rules

> You list the rules that rewrite a transcribed word into the one you want, for one language.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/dictionary/replacements
openapi: 3.0.0
info:
  title: Vook API
  description: >-
    Public transcription API. Authenticate every request with your API key:
    `Authorization: Bearer vk_live_…`.


    ## Transcribe a file (3 calls)


    1. **`POST /api/v1/uploads/init`** → returns an `upload_url`, an
    `upload_token` and the token's `expires_at`.

    2. **`POST {upload_url}`**: POST the whole file to the `upload_url` returned
    by call 1 (**a different host from this API**) as `multipart/form-data` with
    a single `chunk` field, authenticated with `Authorization: Bearer
    {upload_token}`. The file is sent as a single chunk; no chunk index/count is
    needed. This step is on the ingress service and is not listed below.

    3. **`POST /api/v1/transcription-jobs`**: pass the `upload_token` +
    `file_name` + `language` + `diarize`. Returns a job `id`.


    Then **poll `GET /api/v1/transcription-jobs/{id}`** until `status` is
    `completed` (or `failed`). Read the `transcription_id` through **`GET
    /api/v1/transcriptions/{id}`** and its `/transcript` / `/export`
    sub-resources.
  version: v1
  contact: {}
servers:
  - url: https://www.api.vook.ai
    description: Production
security: []
tags: []
paths:
  /api/v1/dictionary/replacements:
    get:
      tags:
        - Dictionary (API v1)
      summary: List replacement rules
      description: >-
        You list the rules that rewrite a transcribed word into the one you
        want, for one language.
      operationId: ApiV1DictionaryController_listReplacements
      parameters:
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            example: '1'
            type: string
        - name: page_size
          required: false
          in: query
          description: Number of items per page. Defaults to 10, up to 100.
          schema:
            minimum: 1
            maximum: 100
            pattern: ^(100|[1-9]\d?)$
            example: '10'
            type: string
        - name: language
          required: true
          in: query
          description: Language of the dictionary to list
          schema:
            $ref: '#/components/schemas/ApiDictionaryLanguage'
      responses:
        '200':
          description: Paginated list of replacement rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedApiReplacementListDto'
      security:
        - bearer: []
components:
  schemas:
    ApiDictionaryLanguage:
      type: string
      enum:
        - en
        - fr
    PaginatedApiReplacementListDto:
      type: object
      properties:
        data:
          description: The list of items for the current page
          type: array
          items:
            $ref: '#/components/schemas/ApiReplacementDto'
        total_count:
          type: number
          example: 100
          description: Total number of items
        current_page:
          type: number
          example: 1
          description: Current page number
        last_page:
          type: number
          example: 10
          description: Last page number
      required:
        - data
        - total_count
        - current_page
        - last_page
    ApiReplacementDto:
      type: object
      properties:
        id:
          type: string
          description: Replacement rule ID
          example: 123e4567-e89b-12d3-a456-426614174000
        language:
          type: string
          description: Language of the dictionary holding the rule
          example: en
        source_word:
          type: string
          description: The word as it gets transcribed
          example: tumbler
        destination_word:
          type: string
          description: The word your transcriptions show instead
          example: Tumblr
        created_at:
          format: date-time
          type: string
          description: When the rule was created
          example: '2024-01-15T10:30:00.000Z'
      required:
        - id
        - language
        - source_word
        - destination_word
        - created_at
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: vk_live_…
      type: http
      description: Your Vook API key (mint one from the web app).

````

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