Video Summarization API

Prior to working with the Video Summarization API, please read through the API Getting Started page to learn about account creation, API keys, and other information on authentication. Each request requires that the appropriate authentication headers are included.

Creating video previews

Create a new video summarization request

POST /v1video-summarization/create

Initiates a video summarization from a target full-length video and a set of summarization parameters.

Request Body

Name	Type	Description
media_url*	str	URL to the media file to process
on_completed_hook	str	URL to be called when summarization is completed. This URL is always triggered, regardless of whether the summarization is successful or not.
options	dict	Options for summarization; see documentation for details.
cache_id	str	For cases when you want to re-process a video with different parameters, you can provide an ID to a previous run. The API will attempt to reuse any cached video data if it exists, which can help to significantly speed up subsequent runs.

200: OK Success

{
    // Response
}

422: Unprocessable Entity Validation error

{
    // Response
}

Query the status of a video summarization operation

GET /v1/status/{run_id}

Request status information on an ongoing video summarization operation.

Query Parameters

Name	Type	Description
run_id*	str	The ID of this summarization run.

200: OK Success

{
    // Response
}

422: Unprocessable Entity Validation error

{
    // Response
}

Cancel a video summarization

GET /v1/cancel/{run_id}

Request cancelation of an ongoing video summarization operation.

Query Parameters

Name	Type	Description
run_id*	str	The ID of this summarization run.

200: OK Success

{
    // Response
}

422: Unprocessable Entity Validation error

{
    // Response
}