v1

latestOpenAPI 3.0.02026-07-175989869.3 KB

Summaries

Generate video summary

Generate an abstract and key takeaways for a video.

post/summaries

Request body

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

attributesstring[]

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.

Example request

{
  "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
  "origin": "auto"
}

Response

Created

summaryIdstring

The unique identifier of the summary object.

createdAtstring date-time

Returns the date and time when the summary was created in ATOM date-time format.

updatedAtstring date-time

Returns the date and time when the summary was last updated in ATOM date-time format.

videoIdstring

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.

Example response

{
  "sourceStatus": "missing",
  "createdAt": "2024-05-28T11:15:07Z",
  "origin": "api",
  "summaryId": "summary_1CGHWuXjhxmeH4WiZ51234",
  "videoId": "vi4k0jvEUuaTdRAEjQ4Prklg",
  "updatedAt": "2024-05-28T11:15:07Z"
}