APapivideo
Captions

List video captions

Changed on

Retrieve a list of available captions by video id.

get/videos/{videoId}/captions

Request

  • Base URL
    https://ws.api.video
  • URL
    https://ws.api.video/videos/{videoId}/captions
  • Auth
    HTTP basic

Path parameters

videoIdstring required

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

Query parameters

currentPageinteger

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

pageSizeinteger

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

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "default": false,
      "src": "https://cdn.api.video/vod/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl.vtt",
      "srclang": "sr-Cyrl",
      "uri": "/videos/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl",
      "languageName": "српски (ћирилица)"
    },
    {
      "default": false,
      "src": "https://cdn.api.video/vod/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl.vtt",
      "srclang": "sr-Cyrl",
      "uri": "/videos/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl",
      "languageName": "српски (ћирилица)"
    }
  ]
}

Changes