Get all task list

This API can receive all task list.

request a task list#

bash
curl -X GET \
     "https://develop.kokoon.cloud/kokoon/api/sr/v3/task?step=running,done&task_type=SR_PREVIEW&page_num=0&page_size=2&start_date=2023-01-01&end_date=2024-05-01" \
     -H "Content-Type:application/json" \
     -H 'Authorization: eyJraWQiOiJPMGs5...eyJzdWIiOiIzN2U3NzYxM'

request query parameter#

filters

field	mandatory	description
task_type	optional	task type( `SR` or `SR_PREVIEW`) `SR` : show only SR tasks. `SR_PREVIEW` : show only SR-preview tasks.
step	optional	filter for specific step. `ready`,`preparing`, `prepared`, `running`, `done`, `cancel`, `unknown`, `error`
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": 9,
  "curr_count": 2,
  "page_size": "2",
  "page_num": "0",
  "step": "running,done",
  "task_type": "SR_PREVIEW",
  "start_date": "2023-01-01",
  "end_date": "2024-05-01",
  "sr_tasks": [
    {
      "tid": "b347b420-c0f7-11ee-9818-5de581da5a32",
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "in_vid": "42a7b910-c032-11ee-9a96-9d78f06e3d9a",
      "out_vid": "b347b421-c0f7-11ee-9818-5de581da5a32",
      "task_type": "SR_PREVIEW",
      "step": "done",
      "filename": "interlaced_10s.mp4",
      "request_time": "2024-02-01T11:47:39.000Z",
      "start_time": "2024-02-01T11:47:41.000Z",
      "finish_time": "2024-02-01T11:47:49.000Z",
      "nb_frames": "313",
      "sr_nb_frames": "5",
      "progress": "0"
    },
    {
      "tid": "ab2f0c70-c0f2-11ee-9818-5de581da5a32",
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "in_vid": "a600c7e0-b5d3-11ee-8bc1-e3593f7b2d5c",
      "out_vid": "ab2f0c71-c0f2-11ee-9818-5de581da5a32",
      "task_type": "SR_PREVIEW",
      "step": "done",
      "filename": "football_360p_10s.mp4",
      "request_time": "2024-02-01T11:11:38.000Z",
      "start_time": "2024-02-01T11:11:40.000Z",
      "finish_time": "2024-02-01T11:11:47.000Z",
      "nb_frames": "300",
      "sr_nb_frames": "5",
      "progress": "5"
    }
  ]
}

response body field#

field	type	description
all_count	int	total item count for filted results.
curr_count	int	item count for current page.
task_type	string	task type( `SR` or `SR_PREVIEW`)
step	string	filter for specific step.
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.

sr_tasks

field	type	description
tid	string	task unique id.
uid	string	user unique id.
in_vid	string	input(original) video unique id.
out_vid	string	output(SR result) video unique id.
task_type	string	task type( `SR` or `SR_PREVIEW`)
step	string	current task step. `ready`, `preparing`, `prepared`, `running`, `done`, `cancel`, `unknown`, `error`
filename	string	original video's filename.
request_time	string	requested time for task.
start_time	string	started time for task.
finish_time	string	finished time for task.
nb_frames	string	total number of frames for original video.
sr_nb_frames	string	total number of frames for SR range of original video.
progress	string	current progressing frame.