Upload a original image

  • First of all, upload a original image to request SR(super-resolution)

request a uploading image#

bash
curl -X POST \
"https://develop.kokoon.cloud/kokoon/api/image/sr/v3/image" \
-H 'Authorization:eyJraWQiOiJPMGs5...eyJzdWIiOiIzN2U3NzYxM' \
-F "file=@original.png"

request body parameter#

  • body format : multipart/form-data
fieldtype
file original binary file to upload.

Restriction#

Input File’s Limits#

  • Resolution : 64x64 ~ 3840x2160 (2160x3840)
  • Format : jpg, jpeg, png, bmp
  • Size: 50MB or less

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/..."
}

response body field#

field type description
uidstringuser's unique id
vidstringimage unique id
pidstringparent_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.
tidstringSR 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_timestringoriginal image's uploading completion time.
filenamestringoriginal image's filename.
sizeintoriginal image's filesize.
codec_namestringoriginal image's codec_name.
fpsstringoriginal image's fps(frame per second).
nb_framesstringoriginal image's number of total frames.
widthintoriginal image's width.
heightintoriginal image's height.
download_cntintoriginal 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_timestringoriginal image's' expired time. original image will be expired after 14day later from created_time.
statestringoriginal image' 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.
urlurloriginal image's url.
thumb_urlurloriginal image's thumbnail url.

error response#

  • timeout error