Sign up for free
  • VOD

Summaries

get

List summaries

List all summarries for your videos in a project.

videoIdstring

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

Example
"vilkR8K3N7yrRcxcMt91234"
originstring

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

Enum
  • auto
  • api
Example
"auto"
sourceStatusstring

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.

Enum
  • missing
  • waiting
  • failed
  • completed
  • unprocessable
Example
"auto"
sortBystring

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.
Enum
  • createdAt
  • updatedAt
  • videoId
Example
"createdAt"
sortOrderstring

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

Enum
  • asc
  • desc
Example
"asc"
currentPageint

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

Default
1
Example
2
pageSizeint

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

Default
25
Example
30

Responses

Response examples

Created

{
  "data": [
    {
      "summaryId": "summary_1CGHWuXjhxmeH4WiZ51234",
      "createdAt": "2024-07-14T23:36:07+00:00",
      "updatedAt": "2024-07-14T23:36:07+00:00",
      "videoId": "vilkR8K3N7yrRcxcMt91234",
      "origin": "auto",
      "sourceStatus": "completed"
    },
    {
      "summaryId": "summary_123HWuXjhxmeH4WiZ55678",
      "createdAt": "2024-07-15T23:36:07+00:00",
      "updatedAt": "2024-07-15T23:36:07+00:00",
      "videoId": "vibaBXK3N7yrRcxcMt95678",
      "origin": "auto",
      "sourceStatus": "waiting"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 25,
    "pagesTotal": 1,
    "itemsTotal": 11,
    "currentPageItems": 11,
    "links": [
      {
        "rel": "self",
        "uri": "https://ws.api.video/summaries?currentPage=1"
      },
      {
        "rel": "first",
        "uri": "https://ws.api.video/summaries?currentPage=1"
      },
      {
        "rel": "last",
        "uri": "https://ws.api.video/summaries?currentPage=1"
      }
    ]
  }
}
post

Generate video summary

Generate an abstract and key takeaways for a video.

videoIdstring

required

Create a summary of a video using the video ID.

Example
"vi4k0jvEUuaTdRAEjQ4Jfrgz"
originstring

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.

Enum
  • auto
Example
"auto"
attributesarray

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.

Responses

Request examples

{
  "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
  "origin": "auto",
  "attributes": [
    "abstract"
  ]
}

Response examples

Created

{
  "summaryId": "summary_1CGHWuXjhxmeH4WiZ51234",
  "createdAt": "2024-07-14T23:36:07+00:00",
  "updatedAt": "2024-07-14T23:36:07+00:00",
  "videoId": "vilkR8K3N7yrRcxcMt91234",
  "origin": "auto",
  "sourceStatus": "completed"
}
delete

Delete video summary

Delete a summary tied to a video.

summaryIdstring

required

The unique identifier of the summary you want to delete.

Example
"summary_1CGHWuXjhxmeH4WiZ51234"

Responses

Response examples

No Content

Empty response

get

Get summary details

Get all details for a summary

summaryIdstring

required

The unique identifier of the summary source you want to retrieve.

Example
"summary_1CGHWuXjhxmeH4WiZ51234"

Responses

Response examples

Success

{
  "abstract": "In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing.",
  "takeaways": [
    "Quantum theory is complicated.",
    "Schrödinger's cat is neither dead, nor alive.",
    "Quantum computers are super cool."
  ]
}
patch

Update summary details

Update details for a summary.

abstractstring

A short outline of the contents of the video.

Example
"In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing."
takeawaysarray

A list of 3 key points from the video, in chronological order.

Example
[ "Quantum theory is complicated.", "Schrödinger's cat is neither dead, nor alive.", "Quantum computers are super cool." ]

Responses

Request examples

{
  "abstract": "In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing.",
  "takeaways": [
    "Quantum theory is complicated.",
    "Schrödinger's cat is neither dead, nor alive.",
    "Quantum computers are super cool."
  ]
}

Response examples

Created

{
  "abstract": "In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing.",
  "takeaways": [
    "Quantum theory is complicated.",
    "Schrödinger's cat is neither dead, nor alive.",
    "Quantum computers are super cool."
  ]
}

Was this page helpful?