Show a chapter

GET

/videos/{videoId}/chapters/{language}

Chapters

Chapters help your viewers find the sections of the video they are most interested in viewing. Tutorials that use the chapters endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/chapters/en'

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 show a chapter for.

Example:

vi4k0jvEUuaTdRAEjQ4Jfrgz

language

string

required

A valid BCP 47 language representation.

Example:

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

🟠404Not Found

Modified at 2023-08-15 05:52:15

Delete a chapter

Upload a chapter