Chapters - Multipart
POST {{video-api-server}}/chapters/upload?chapter_mode=advanced
This endpoint allows users to upload a video file and create chapter markers in .vtt
format. Optionally, chapter markers can be embedded directly into the video metadata using advanced chapter handling.
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 the chapter markers into the video metadata. |
Request Body
[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"chapters", "value"=>"[{\"title\": \"chapter1\", \"start_time\": \"00:00:10\"}]", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Filerobot-Token | string | Filerobot project identifier, aka token | |
Filerobot-Key | string | Filerobot API key |
RESPONSES
status: OK
{"status":"ok","version":2.11,"result":[{"uuid":"5a140a20-c09c-4e97-b7aa-33a77bb493af","file":"pexels_videos_2795402 (720p)","chapters":"https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/VfTdR_pexels_videos_2795402%20%28720p%29/pexels_videos_2795402%20%28720p%29_chapters.mp4","vtt":"https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/VfTdR_pexels_videos_2795402%20%28720p%29/pexels_videos_2795402%20%28720p%29_vtt.vtt","sha1":"2006fbd8ace6e11b6c0b44659def73ee3d120cc4","progress":"https://api.filerobot.com/fbmjmuoeb/v4/video-status/ZXUtb3YtNzA2LWdyYTIuZWxhc3RpYy11cGxvYWRlci5haXJzdG9yZS5zY2FsM2ZsM3guY29tOjg3MzI__5a140a20-c09c-4e97-b7aa-33a77bb493af"}]}