Listing videos API

You may list the existing videos, using project's key and/or some filter criterias.

Request Endpoint

GET https://stream.byteark.com/api/v1/videos

Query String Parameters

Parameter	Type	Required	Description
projectKey	String	-	List only videos in the specific project by project key
tagIds	[]String	-	List only video that has at least one of the specific tags (by tag's id)
includes	[]String	-	Include more details about the video (Possible values: project,player,tags,creator,vod.source)
page	Number	-	Determines page index (starts at 1).
size	Number	-	Determines number of videos to be response per page.

Response Data

The list of the videos. Important fields are showing below as an example, including the title, subtitle, and primary playback URLs.

Full response data format available in the API Reference (opens new window).

{
  "total": 2,
  "from": 1,
  "to": 2,
  "currentPage": 1,
  "lastPage": 1,
  "perPage": 20,
  "data": [
    {
      "id": "5e817a8cecb9cf0228467837",
      "key": "RuguHtZPJYm4",
      "title": "test-video1",
      "coverImage": {
        sizes: {
          large: "https://stream-image.byteark.com/image/video-cover-1080p/7/t/7tYplH8ol.png",
          medium: "https://stream-image.byteark.com/image/video-cover-480p/7/t/7tYplH8ol.png",
          small: "https://stream-image.byteark.com/image/video-cover-144p/7/t/7tYplH8ol.png"
        }
      },
      "primaryPlaybackUrl": {
        name: "playback",
        hls: {
          name: "Adaptive Bitrate",
          url: "https://your-playback-domain/streams/VideoKey/playlist.m3u8"
        }
      }
    },
    {
      "id": "5e817a8cecb9cf0228467837",
      "key": "RuguHtZPJYm4",
      "title": "test-video1",
      "coverImage": {
        sizes: {
          large: "https://stream-image.byteark.com/image/video-cover-1080p/7/t/7tYplH8ol.png",
          medium: "https://stream-image.byteark.com/image/video-cover-480p/7/t/7tYplH8ol.png",
          small: "https://stream-image.byteark.com/image/video-cover-144p/7/t/7tYplH8ol.png"
        }
      },
      "primaryPlaybackUrl": {
        name: "playback",
        hls: {
          name: "Adaptive Bitrate",
          url: "https://your-playback-domain/streams/VideoKey/playlist.m3u8"
        }
      }
    }
  ]
}