Generate video chapters | FastPix Developer Documentation

This endpoint enables you to generate chapters for an existing media file. #### How it works 1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media for which you want to generate chapters. 2. Include the `chapters` parameter in the request body to enable. 3. The response contains the updated media data, confirming the changes made. You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation. **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video. Related guide: <a href="https://docs.fastpix.io/docs/generate-video-chapters">Video chapters</a>

This endpoint enables you to generate chapters for an existing media file.

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media for which you want to generate chapters.
Include the chapters parameter in the request body to enable.
The response contains the updated media data, confirming the changes made.

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

Use case: This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.

Related guide: Video chapters

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.

chaptersbooleanRequiredDefaults to true

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

Response

Media details updated successfully with the chapters feature enabled or disabled

successboolean

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

dataobject

This endpoint enables you to generate chapters for an existing media file.

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media for which you want to generate chapters.
Include the chapters parameter in the request body to enable.
The response contains the updated media data, confirming the changes made.

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

Use case: This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.

Related guide: Video chapters

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 chapters feature for the media. Set to true to enable chapters or false to disable.

Media details updated successfully with the chapters feature enabled or disabled

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/chapters \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"chapters": true
>	}'

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

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

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