List video captions

Retrieve a list of available captions for the videoId you provide.

{ "data": [ { "default": false, "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/captions/en.vtt", "srclang": "en", "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions/en" }, { "default": false, "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/captions/fr.vtt", "srclang": "fr", "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions/fr" } ], "pagination": { "currentPage": 1, "currentPageItems": 2, "itemsTotal": 2, "links": [ { "rel": "self", "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions?currentPage=1&pageSize=25" }, { "rel": "first", "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions?currentPage=1&pageSize=25" }, { "rel": "last", "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions?currentPage=1&pageSize=25" } ], "pageSize": 25, "pagesTotal": 1 } }

Request

Path Params

videoId

string

required

The unique identifier for the video you want to retrieve a list of captions for.

Example:

vi4k0jvEUuaTdRAEjQ4Prklg

Query Params

currentPage

integer

optional

Choose the number of search results to return per page. Minimum value: 1

Example:

pageSize

integer

optional

Results per page. Allowed values 1-100, default is 25.

Example:

Responses

🟢200Success

application/json

Body

data

array[object (Subtitle) {4}]

optional

default

boolean

optional

Whether you will have subtitles or not. True for yes you will have subtitles, false for no you will not have subtitles.

Default:

false

Example:

false

src

string

optional

srclang

string

optional

uri

string

optional

pagination

object (Pagination)

optional

Example:

{"currentPage":3,"currentPageItems":20,"itemsTotal":123,"links":{"first":{"rel":"first","uri":"/videos/search?currentPage=1&pageSize=20"},"last":{"rel":"last","uri":"/videos/search?currentPage=6&pageSize=20"},"next":{"rel":"next","uri":"/videos/search?currentPage=4&pageSize=20"},"previous":{"rel":"previous","uri":"/videos/search?currentPage=2&pageSize=20"}},"pageSize":20,"pagesTotal":7}

currentPage

integer

read-onlyoptional

The current page index.

currentPageItems

integer

read-onlyoptional

The number of items on the current page.

itemsTotal

integer

read-onlyoptional

Total number of items that exist.

links

array[object (PaginationLink) {2}]

required

pageSize

integer

read-onlyoptional

Maximum number of item per page.

pagesTotal

integer

read-onlyoptional

Number of items listed in the current page.

🟠404Not Found