---
title: "Generate video summary"
method: POST
path: "/summaries"
tags: ["Summaries"]
---

# Generate video summary

`POST /summaries`

Generate an abstract and key takeaways for a video.

## Request body

- SummaryCreationPayload
  - `videoId` string, required — Create a summary of a video using the video ID.
  - `origin` 'auto' — Use this parameter to define how the API generates the summary. The only allowed value is `auto`, which means that the API generates a summary automatically. If you do not set this parameter, **the API will not generate a summary automatically**. In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation.
  - `attributes` string[] — Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.

## Response `201`

Created

- Summary
  - `summaryId` string — The unique identifier of the summary object.
  - `createdAt` string, date-time — Returns the date and time when the summary was created in ATOM date-time format.
  - `updatedAt` string, date-time — Returns the date and time when the summary was last updated in ATOM date-time format.
  - `videoId` string — The unique identifier of the video object.
  - `origin` 'api' | 'auto' — Returns the origin of how the summary was created. - `api` means that no summary was generated automatically. You can add summary manually using the `PATCH /summaries/{summaryId}/source` endpoint operation. Until this happens, `sourceStatus` returns `missing`. - `auto` means that the API generated the summary automatically.
  - `sourceStatus` 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable' — Returns the current status of summary generation. `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio.

## Other responses

- `409` — Conflict

---

[API](https://skmtc.net/apivideo/apis/api-video.md) · [All operations](https://skmtc.net/apivideo/apis/api-video/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apivideo/api-video/revisions/45ec26f342b6/schema)