Generate video summary

This endpoint allows you to generate the summary for an existing media.

How it works

1. Send a PATCH request to this endpoint, replacing <mediaId> with the unique ID of the media for which you wish to generate a summary.
2. Include the generate parameter in the request body.
3. Include the summaryLength parameter, specify the desired length of the summary in words (e.g., 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
4. The response will include the updated media data and confirmation of the changes applied.

You can use the video.mediaAI.summary.ready webhook event to track and notify about the summary generation.

Use case: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.

Related guide: Video summary