Getting video information from API

You may getting information about a Video, using the video's key.

Request Endpoint

GET https://stream.byteark.com/api/v1/videos/{videoKey}

Path Parameters

Parameter	Type	Required	Description
videoKey	String	-	The Video Key to get information

Query String Parameters

Parameter	Type	Required	Description
includes	[]String	-	Include more details about the video (Possible values: project,player,tags,creator,vod.source)

Response Data

The information of the video. 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).

{
  "id": "5e817a8cecb9cf0228467837",
  "key": "RuguHtZPJYm4",
  "title": "test-video1",
  "subtitle": "awesome movie you'll never seen before",
  "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"
    }
  }
}