API Reference
Login

Generate video chapters

patch
https://api.fastpix.io/v1/on-demand//chapters

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 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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

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

Body Params
boolean
required
Defaults to true

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

Responses

Updated 4 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago