api.video
  1. Chapters
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
    • List all active upload tokens.
    • Generate an upload token
    • Delete an upload token
    • Show upload token
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
      GET
    • Delete a chapter
      DELETE
    • Show a chapter
      GET
    • Upload a chapter
      POST
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Chapters

Upload a chapter

POST
/videos/{videoId}/chapters/{language}
Chapters
Chapters help break the video into sections. Read our tutorial for more details.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/chapters/en' \
--form 'file=@""'
Response Response Example
200 - response
{
  "language": "fr",
  "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/chapters/fr.vtt",
  "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/chapters/fr"
}

Request

Path Params
videoId
string 
required
The unique identifier for the video you want to upload a chapter for.
Example:
vi4k0jvEUuaTdRAEjQ4Jfrgz
language
string 
required
A valid BCP 47 language representation.
Example:
en
Body Params multipart/form-data
file
file 
required
The VTT file describing the chapters you want to upload.

Responses

🟢200Success
application/json
Body
language
string 
optional
src
string 
optional
The link to your VTT file, which contains your chapters information for the video.
Example:
https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/chapters/fr.vtt
uri
string 
optional
🟠400Bad Request
🟠404Not Found
Modified at 2023-08-15 05:52:15
Previous
Show a chapter
Next
List all webhooks
Built with