Generate video summary | FastPix Developer Documentation

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 ID of the media you want to summarize. 2. Include the `generate` parameter in the request body. 3. Include the `summaryLength` parameter, 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. 4. The response includes the updated media data and confirmation of the changes applied. You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> 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: <a href="https://docs.fastpix.io/docs/generate-video-summary">Video summary</a>

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

How it works

Send a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to summarize.
Include the generate parameter in the request body.
Include the summaryLength parameter, 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

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

mediaIdstringRequiredformat: "uuid"

The unique identifier assigned to the media when created. The value must be a valid UUID.

Request

This endpoint expects an object.

generatebooleanRequired

Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.

summaryLengthintegerOptional30-250Defaults to 100

Specifies the desired word count for the generated summary.

The value must be between 30 and 250 words.

Response

Media details updated successfully with the generated summary

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

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

How it works

Send a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to summarize.
Include the generate parameter in the request body.
Include the summaryLength parameter, 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

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

The unique identifier assigned to the media when created. The value must be a valid UUID.

This endpoint expects an object.

Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.

Specifies the desired word count for the generated summary.

The value must be between 30 and 250 words.

Media details updated successfully with the generated summary

Shows the request status. Returns true for success and false for failure.

$	curl -X PATCH https://api.fastpix.com/v1/on-demand/4fa85f64-5717-4562-b3fc-2c963f66afa6/summary \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"generate": true,
>	"summaryLength": 100
>	}'

1	{
2	"success": true,
3	"data": {
4	"mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
5	"isSummaryEnabled": true
6	}
7	}

$	curl -X PATCH https://api.fastpix.com/v1/on-demand/4fa85f64-5717-4562-b3fc-2c963f66afa6/summary \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"generate": true,
>	"summaryLength": 100
>	}'

1	{
2	"success": true,
3	"data": {
4	"mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
5	"isSummaryEnabled": true
6	}
7	}