---
title: "List summaries"
method: GET
path: "/summaries"
tags: ["Summaries"]
---

# List summaries

`GET /summaries`

List all summarries for your videos in a project.

## Query parameters

- `videoId` string
- `origin` 'auto' | 'api'
- `sourceStatus` 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable'
- `sortBy` 'createdAt' | 'updatedAt' | 'videoId'
- `sortOrder` 'asc' | 'desc'
- `currentPage` integer
- `pageSize` integer

## Response `200`

Created

- SummariesListResponse
  - `data` Summary[], required — An array of summary objects.
    - `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.
  - `pagination` Pagination, required
    - `itemsTotal` integer — Total number of items that exist.
    - `pagesTotal` integer — Number of items listed in the current page.
    - `pageSize` integer — Maximum number of item per page.
    - `currentPage` integer — The current page index.
    - `currentPageItems` integer — The number of items on the current page.
    - `links` PaginationLink[], required
      - `rel` string
      - `uri` string, uri

---

[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)