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

# Add a vocabulary word

> You teach your transcriptions a word or a name, such as a product or a person. It applies to every transcription in that language, from the API and the web app alike. Adding a word you already have returns it, so you can send your full list again safely.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/dictionary/vocabulary
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/vocabulary:
    post:
      tags:
        - Dictionary (API v1)
      summary: Add a vocabulary word
      description: >-
        You teach your transcriptions a word or a name, such as a product or a
        person. It applies to every transcription in that language, from the API
        and the web app alike. Adding a word you already have returns it, so you
        can send your full list again safely.
      operationId: ApiV1DictionaryController_addVocabulary
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateVocabularyEntryDto'
      responses:
        '200':
          description: The vocabulary entry, new or existing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiVocabularyEntryDto'
        '400':
          description: >-
            The request is invalid, or the word is a common word such as "the"
            that would rewrite ordinary speech in every transcript (error code:
            dictionary_entry_common_word)
      security:
        - bearer: []
components:
  schemas:
    ApiCreateVocabularyEntryDto:
      type: object
      properties:
        language:
          description: Language of the dictionary to add to
          example: en
          allOf:
            - $ref: '#/components/schemas/ApiDictionaryLanguage'
        word:
          type: string
          minLength: 1
          maxLength: 255
          description: >-
            A word or name your transcriptions should recognize, such as a
            product or a person
          example: Tumblr
      required:
        - language
        - word
    ApiVocabularyEntryDto:
      type: object
      properties:
        id:
          type: string
          description: Vocabulary entry ID
          example: 123e4567-e89b-12d3-a456-426614174000
        language:
          type: string
          description: Language of the dictionary holding the entry
          example: en
        word:
          type: string
          description: The vocabulary word
          example: Tumblr
        created_at:
          format: date-time
          type: string
          description: When the entry was created
          example: '2024-01-15T10:30:00.000Z'
      required:
        - id
        - language
        - word
        - created_at
    ApiDictionaryLanguage:
      type: string
      enum:
        - en
        - fr
  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.