patch
https://api.fastpix.io/v1/on-demand//summary
This endpoint allows you to generate the summary for an existing media.
How it works
- Send a
PATCHrequest to this endpoint, replacing<mediaId>with the ID of the media you want to summarize. - Include the
generateparameter in the request body. - Include the
summaryLengthparameter, specify the desired length of the summary in words (for example, 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. - The response includes 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