Get all video list

This API can receive all uploaded video list.

bash
curl -X GET \
     "https://develop.kokoon.cloud/kokoon/api/sr/v4.1/video?orig_type=original,sr,pv_sr&filename=football&order_field=expired_time&order=asc&page_size=2&page_num=0&start_date=2022-01-19&end_date=2023-01-19" \
     -H "Content-Type:application/json" \
     -H 'Authorization: eyJraWQiOiJPMGs5...eyJzdWIiOiIzN2U3NzYxM'

request query parameter#

filters

field	mandatory	description
orig_type	optional	origin for video( `original` or `sr` or `pv_sr`) `original` : show only original files. `sr` : show only SRresult files. `pv_sr` : show only preview-SRresult files.
filename	optional	search with partial filename.
order_field	optional(default : `created_time`)	sorting with specific field. supported order fields type : `created_time`, `expired_time`, `filename`
order	optional	ordering. `asc` or `desc` (default : `desc`)
page_size	optional	size per page for pagenation.(page_num is required.)
page_num	optional	current page for pagenation.(page_size is required.)
start_date	optional	start date
end_date	optional	end date

response#

json
{
  "all_count": 7,
  "curr_count": 2,
  "page_size": "2",
  "page_num": "0",
  "orig_type": "original,sr,pv_sr",
  "filename": "football",
  "start_date": "2023-01-01",
  "end_date": "2024-05-01",
  "order_field": "expired_time",
  "order": "asc",
  "videos": [
    {
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "vid": "9f6bf740-c025-11ee-bcc2-490e08f2a351",
      "pid": "00000000-0000-0000-0000-000000000000",
      "tid": "00000000-0000-0000-0000-000000000000",
      "created_time": "2024-01-30T10:43:54.000Z",
      "filename": "football_360p_10s.mp4",
      "size": 939073,
      "codec_name": "h264",
      "width": 640,
      "height": 360,
      "fps": "30/1",
      "nb_frames": "300",
      "duration": "10.000000",
      "bitrate": "739484",
      "expired_time": "2024-02-13T10:43:54.000Z",
      "download_cnt": 0,
      "last_category": null,
      "state": "completed",
      "orig_type": "original",
      "url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/...",
      "thumb_url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/..."
    },
    {
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "vid": "b3b551b0-bf44-11ee-b7b1-bde2d5ef838d",
      "pid": "9f6bf740-c025-11ee-bcc2-490e08f2a351",
      "tid": "de113fa0-767c-11f0-b641-ed06272fca96",
      "created_time": "2024-01-31T08:53:50.000Z",
      "filename": "football_360p_10s--SR_coral_v1.0__640x360_h264.mp4",
      "size": 363347,
      "codec_name": "h264",
      "width": 640,
      "height": 360,
      "fps": "30/1",
      "nb_frames": "90",
      "duration": "3.000000",
      "bitrate": "954261",
      "expired_time": "2024-02-14T08:53:50.000Z",
      "download_cnt": 0,
      "last_category": "general",
      "state": "completed",
      "orig_type": "sr",
      "url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/...",
      "thumb_url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/..."
    },
    {
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "vid": "b3b551b0-bf44-11ee-b7b1-bde2d5ef838d",
      "pid": "9f6bf740-c025-11ee-bcc2-490e08f2a351",
      "tid": "90607c30-767c-11f0-b641-ed06272fca96",
      "created_time": "2024-01-31T07:53:50.000Z",
      "filename": "football_360p_10s--SR_coral_v1.0__640x360_h264.mp4",
      "size": 363347,
      "codec_name": "h264",
      "width": 640,
      "height": 360,
      "fps": "30/1",
      "nb_frames": "90",
      "duration": "3.000000",
      "bitrate": "954261",
      "expired_time": "2024-02-14T07:53:50.000Z",
      "download_cnt": 0,
      "last_category": "general",
      "state": "completed",
      "orig_type": "pv_sr",
      "url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/...",
      "thumb_url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/..."
    }
  ]
}

response body field#

field	type	description
all_count	int	total item count for filted results.
curr_count	int	item count for current page.
orig_type	string	origin for video( `original` or `sr` or `pv_sr`)
filename	string	filename
order_field	string	sorting with specific field.
order	string	ordering.
page_num	string	current page for pagenation.
page_size	string	size per page for pagenation.
start_date	string	start date.
end_date	string	end date.

videos

field	type	description
uid	string	user's unique id
vid	string	video unique id
pid	string	parent_id : if video file is original, parent_id is '00000000-0000-0000-0000-000000000000'. if video file is SR result, parent_id is original file's vid used when SR is requested.
tid	string	SR task_id : if video file is original, task_id is '00000000-0000-0000-0000-000000000000'. if video file is SR result, task_id is a unique task-id recevied when SR is requested.
created_time	string	video's created time.
filename	string	video's filename.
size	int	video's filesize.
codec_name	string	video's codec_name.
fps	string	video's fps(frame per second).
duration	string	video's duration.(seconds)
nb_frames	string	video's number of total frames.
bitrate	string	video's bitrate.(bits per second)
width	int	video's width.
height	int	video's height.
download_cnt	int	video's downloding count. We cannot figure out that a user really downloaded a original file with url. But we can provide a download-inc-count API. After a user really download a file with url, if call download-inc-count API, download_cnt will be increased.
expired_time	string	video's expired time. original video will be expired after 14day later from created_time.
state	string	video's state. In case of original file, state is always 'completed'. state : pending : SR video creation is requested. processing : SR video creation is in processing. completed : SR video creation is completed. error : SR video creation is failed.
orig_type	string	origin for video( `original` or `sr` or `pv_sr`) orig_type : original : original video-type. sr : SRresult video-type. pv_sr : preview-SRresult video-type.
url	url	video's url.
thumb_url	url	video's thumbnail url.
last_category	string	last selected category in SR task.

request a video list#

request query parameter#

response#

response body field#