Chapters - URL
POST {{video-api-server}}/chapters/url?chapter_mode=advanced
This endpoint generates chapter markers in .vtt
(WebVTT) format and optionally embeds them into the video metadata for enhanced chapter handling. It is designed for videos accessible via HTTP protocol, allowing both basic and advanced chapter management options.
Body Parameters:
url
(string, required) - URL of the video file on which the chapter markers are to be appliedchapters
(array of objects, required) - List of chapters to be applied to the video.
Every chapter object contains:
title
(string, optional) - title of the video chapterstart_time
(string, required) - The start time of the chapter inhh:mm:ss
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
chapter_mode | string | Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. |
Can be either:
- basic - Generates only a .vtt file.
- advanced - Generates a .vtt file and embeds chapter markers into the video metadata. |
Request Body
{"0"=>{"url"=>"https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/combined_videos/QFtsC/16343098_2231485_combined.mp4", "chapters"=>[{"title"=>"car", "start_time"=>"00:00:00"}, {"title"=>"beach", "start_time"=>"00:00:08"}]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Filerobot-Token | string | Filerobot project identifier, aka token | |
Filerobot-Key | string | The API key for authenticating requests |
RESPONSES
status: OK
{"status":"ok","version":2.11,"result":[{"uuid":"b1ff4269-5b80-48a0-996f-247fa4d0d231","url":"https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/combined_videos/QFtsC/16343098_2231485_combined.mp4","chapters":"https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/vcDtF_16343098_2231485_combined/16343098_2231485_combined_chapters.mp4","vtt":"https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/vcDtF_16343098_2231485_combined/16343098_2231485_combined_vtt.vtt","sha1":"6f83b865731dbe193cbc4f885a0cffb87b92153b","progress":"https://api.filerobot.com/fbmjmuoeb/v4/video-status/ZXUtb3YtNzA2LWdyYTIuZWxhc3RpYy11cGxvYWRlci5haXJzdG9yZS5zY2FsM2ZsM3guY29tOjg3MzI__b1ff4269-5b80-48a0-996f-247fa4d0d231"}]}