Chapters

List video chapters

Retrieve a list of all chapters for by video id.

get/videos/{videoId}/chapters

Path parameters

videoIdstring required

The unique identifier for the video you want to retrieve a list of chapters 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": [
    {
      "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/chapters/fr.vtt",
      "language": "language",
      "uri": "uri"
    },
    {
      "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/chapters/fr.vtt",
      "language": "language",
      "uri": "uri"
    }
  ]
}

Changes

Changed in 3 of the 50 revisions of this API.66

    • added the non-success response with the status

      response-non-success-status-added

    • the endpoint scheme security apiKey was added to the API

      api-security-added

    • the endpoint scheme security bearerAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the optional response header X-RateLimit-Limit removed for the status 200

      optional-response-header-removed

    • the optional response header X-RateLimit-Limit removed for the status 404

      optional-response-header-removed

    • the optional response header X-RateLimit-Remaining removed for the status 200

      optional-response-header-removed

    • the optional response header X-RateLimit-Remaining removed for the status 404

      optional-response-header-removed

    • the optional response header X-RateLimit-Retry-After removed for the status 200

      optional-response-header-removed

    • the optional response header X-RateLimit-Retry-After removed for the status 404

      optional-response-header-removed

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security apiKey was removed from the API

      api-security-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.