Get a task information

This API can receive a task infomation for task unique id.

request a task information#

bash
curl -X GET \
     "https://develop.kokoon.cloud/kokoon/api/image/sr/v3/task/${tid}" \
     -H "Content-Type:application/json" \
     -H 'Authorization: eyJraWQiOiJPMGs5...eyJzdWIiOiIzN2U3NzYxM'

request parameter#

tid : task unique id

response#

json
{
  "request_body": {
    "option": {
      "face_enhance": true,
      "denoise": true,
      "add_noise": true
    },
    "task_type": "SR_IMAGE_PREVIEW",
    "category": "general",
    "use_sr": true,
    "input_quality": "high",
    "vid": "a600c7e0-b5d3-11ee-8bc1-e3593f7b2d5c",
    "width": 1280,
    "height": 720,
    "codec": "png",
    "format": "png"
  },
  "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
  "tid": "89f758a0-ba76-11ee-8fa6-17cde62e8e05",
  "in_vid": "a600c7e0-b5d3-11ee-8bc1-e3593f7b2d5c",
  "out_vid": "89f758a1-ba76-11ee-8fa6-17cde62e8e05",
  "task_type": "SR_IMAGE_PREVIEW",
  "step": "done",
  "filename": "football_1.png",
  "request_time": "2024-01-24T05:07:58.000Z",
  "start_time": "2024-01-24T05:09:06.000Z",
  "finish_time": "2024-01-24T05:09:32.000Z",
  "result_message": "success",
  "bitrate": "0",
  "fps": "25/1",
  "nb_frames": "1",
  "sr_nb_frames": "1",
  "progress": "1",
"preview_orig_url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/42a7b910-c032-11ee-9a96-9d78f06e3d9a/preview/orig_b347b420-c0f7-11ee-9818-5de581da5a32...",
  "preview_sr_url": "https://sr-inner-api-storage-local.s3.amazonaws.com/video/539e3480-929a-11ee-ada2-51e4bfe11414/42a7b910-c032-11ee-9a96-9d78f06e3d9a/preview/sr_b347b420-c0f7-11ee-9818-5de581da5a32..."
}

response body field#

field	type	description
request_body	object	task request's body parameter when task created.
tid	string	task unique id.
uid	string	user unique id.
in_vid	string	input(original) image unique id.
out_vid	string	output(SR result) image unique id.
task_type	string	task type( `SR_IMAGE` or `SR_IMAGE_PREVIEW`)
step	string	current task step. `ready`, `preparing`, `prepared`, `running`, `done`, `cancel`, `unknown`, `error`
result_message	string	result message for SR task.
filename	string	original image's filename.
fps	string	original image's frame per second.
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 image.
sr_nb_frames	string	total number of frames for SR range of original image.
progress	string	current progressing frame.
preview_orig_url	string	in case of PREVIEW task, original file's url.
preview_sr_url	string	in case of PREVIEW task, SR-result file's url.

error response#

task does not exist.

json
{
  "message": "fail to get result."
}