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

# Get the summary of a transcription

> You read the summary of a transcription. While it is being generated, its status is processing. A not found answer after a processing one means the generation failed: create the summary again.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/transcriptions/{id}/summary
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/transcriptions/{id}/summary:
    get:
      tags:
        - Summaries (API v1)
      summary: Get the summary of a transcription
      description: >-
        You read the summary of a transcription. While it is being generated,
        its status is processing. A not found answer after a processing one
        means the generation failed: create the summary again.
      operationId: ApiV1SummaryController_get
      parameters:
        - name: id
          required: true
          in: path
          description: Transcription ID
          schema:
            example: 123e4567-e89b-12d3-a456-426614174000
            type: string
      responses:
        '200':
          description: The summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSummaryDto'
        '404':
          description: >-
            The transcription does not exist, or it has no summary (error code:
            summary_not_found)
      security:
        - bearer: []
components:
  schemas:
    ApiSummaryDto:
      type: object
      properties:
        transcription_id:
          type: string
          description: ID of the summarized transcription
          example: 123e4567-e89b-12d3-a456-426614174000
        status:
          description: >-
            completed once the summary is written. processing while it is being
            generated: poll this summary until it is completed.
          example: completed
          allOf:
            - $ref: '#/components/schemas/ApiSummaryStatus'
        summary:
          type: string
          nullable: true
          description: >-
            The summary, as Markdown, in the language of the transcript. Null
            while processing.
          example: |-
            ## Key points

            - The launch moves to March.
        created_at:
          format: date-time
          type: string
          description: When the summary was requested
          example: '2024-01-15T10:30:00.000Z'
      required:
        - transcription_id
        - status
        - summary
        - created_at
    ApiSummaryStatus:
      type: string
      enum:
        - processing
        - completed
      description: >-
        completed once the summary is written. processing while it is being
        generated: poll this summary until it is completed.
  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.