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

# Create a transcription job from an uploaded file or a URL

> Send an upload_token from POST /api/v1/uploads/init, or a direct https url to a media file. A url is checked before the job is created: a link that is not reachable media answers with a url_* error code.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/transcription-jobs
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/transcription-jobs:
    post:
      tags:
        - Transcription jobs (API v1)
      summary: Create a transcription job from an uploaded file or a URL
      description: >-
        Send an upload_token from POST /api/v1/uploads/init, or a direct https
        url to a media file. A url is checked before the job is created: a link
        that is not reachable media answers with a url_* error code.
      operationId: ApiV1TranscriptionJobsController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateTranscriptionJobDto'
      responses:
        '201':
          description: Transcription job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateTranscriptionJobResponseDto'
        '402':
          description: >-
            Your API credit balance is empty (error code:
            insufficient_api_credits). Top up to dispatch new jobs.
        '409':
          description: >-
            No stored file for the upload_token (error code: upload_not_found).
            Upload to upload_url, wait for its success response, then submit
            again with the same token.
      security:
        - bearer: []
components:
  schemas:
    ApiCreateTranscriptionJobDto:
      type: object
      properties:
        upload_token:
          type: string
          description: >-
            Upload token returned by POST /api/v1/uploads/init. Send either
            upload_token or url.
        url:
          type: string
          maxLength: 2048
          description: >-
            Direct https link to an audio or video file, such as a presigned
            object URL. We fetch it for you. Send either upload_token or url.
          example: https://example.com/recordings/meeting.mp3
        file_name:
          type: string
          description: Original file name. Required with upload_token, optional with url.
          example: meeting.mp3
        language:
          type: string
          description: >-
            Spoken language code, such as 'en' or 'fr'. Send 'auto' to let us
            detect it; the transcription then reports the detected code.
          example: auto
        diarize:
          type: boolean
          description: Whether to diarize (separate speakers)
          example: false
        name:
          type: string
          maxLength: 255
          description: Display name for the resulting transcription(s)
          example: Team weekly sync
        callback_url:
          type: string
          maxLength: 2048
          description: >-
            Webhook endpoint notified once, when the job reaches a terminal
            status. Public https, standard port. Omit it to poll instead.
          example: https://example.com/vook/webhook
      required:
        - language
        - diarize
    ApiCreateTranscriptionJobResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Transcription job ID
          example: 123e4567-e89b-12d3-a456-426614174000
        status:
          description: Job lifecycle status
          example: queued
          allOf:
            - $ref: '#/components/schemas/TranscriptionJobStatus'
      required:
        - id
        - status
    TranscriptionJobStatus:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
      description: Job lifecycle status
  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.