v1

latestOpenAPI 3.0.02026-07-175989869.3 KB

Summaries

List summaries

List all summarries for your videos in a project.

get/summaries

Query parameters

videoIdstring

Use this parameter to filter for a summary that belongs to a specific video.

origin'auto' | 'api'

Use this parameter to filter for summaries based on the way they were created: automatically or manually via the API.

sourceStatus'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable'

Use this parameter to filter for summaries based on the current status of the summary source.

These are the available statuses:

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.

sortBy'createdAt' | 'updatedAt' | 'videoId'

Use this parameter to choose which field the API will use to sort the response data. The default is value.

These are the available fields to sort by:

createdAt: Sorts the results based on date and timestamps when summaries were created.
updatedAt: Sorts the results based on date and timestamps when summaries were last updated.
videoId: Sorts the results based on video IDs.

sortOrder'asc' | 'desc'

Use this parameter to sort results. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Created

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "sourceStatus": "missing",
      "createdAt": "2024-05-28T11:15:07Z",
      "origin": "api",
      "summaryId": "summary_1CGHWuXjhxmeH4WiZ51234",
      "videoId": "vi4k0jvEUuaTdRAEjQ4Prklg",
      "updatedAt": "2024-05-28T11:15:07Z"
    },
    {
      "sourceStatus": "missing",
      "createdAt": "2024-05-28T11:15:07Z",
      "origin": "api",
      "summaryId": "summary_1CGHWuXjhxmeH4WiZ51234",
      "videoId": "vi4k0jvEUuaTdRAEjQ4Prklg",
      "updatedAt": "2024-05-28T11:15:07Z"
    }
  ]
}