Get a image information

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

request a image information#

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

request parameter#

vid : image unique id.

response#

json
{
  "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
  "vid": "de5e9990-c0fb-11ee-961f-d12490e606ad",
  "pid": "00000000-0000-0000-0000-000000000000",
  "tid": "00000000-0000-0000-0000-000000000000",
  "created_time": "2024-02-01T12:17:32.699Z",
  "filename": "original.png",
  "size": 939073,
  "codec_name": "png",
  "fps": "25/1",
  "duration": "0",
  "nb_frames": "1",
  "bitrate": "0",
  "width": 640,
  "height": 360,
  "download_cnt": 0,
  "expired_time": "2024-02-15T12:17:32.699Z",
  "state": "completed",
  "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/...",
  "last_category": null
}

response body field#

field	type	description
uid	string	user's unique id
vid	string	image unique id
pid	string	parent_id : if image file is original, parent_id is '00000000-0000-0000-0000-000000000000'. if image file is SR result, parent_id is original file's vid used when SR is requested.
tid	string	SR task_id : if image file is original, task_id is '00000000-0000-0000-0000-000000000000'. if image file is SR result, task_id is a unique task-id recevied when SR is requested.
created_time	string	image's created time.
filename	string	image's filename.
size	int	image's filesize.
codec_name	string	image's codec_name.
fps	string	image's fps(frame per second).
nb_frames	string	image's number of total frames.
width	int	image's width.
height	int	image's height.
download_cnt	int	image'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	image's expired time. original image will be expired after 14day later from created_time.
state	string	image's state. In case of original file, state is always 'completed'. state : pending : SR image creation is requested. processing : SR image creation is in processing. completed : SR image creation is completed. error : SR image creation is failed.
url	url	image's url.
thumb_url	url	image's thumbnail url.
last_category	string	last selected category in SR task.

error response#

image does not exist.

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