Skip to main content
GET
/
api
/
jobs
/
history
/
{id}
Get details of a specific video enhancement job
curl --request GET \
  --url https://backend.tensorpix.ai/api/jobs/history/{id}/ \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "started": "2023-11-07T05:31:56Z",
  "finished": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "input_video": {
    "id": 123,
    "name": "<string>",
    "width": 123,
    "height": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "n_frames": 123,
    "framerate": 123,
    "size": 123,
    "owner": "[email protected]",
    "thumbnail": "<string>",
    "external_url": "<string>",
    "bitrate": 123,
    "codec_id": "<string>",
    "bit_depth": 123,
    "chroma_subsampling": "<string>",
    "color_space": "<string>",
    "file": "<string>"
  },
  "output_video": {
    "id": 123,
    "job_id": 123,
    "preview_videos": {
      "before_video": "<string>",
      "after_video": "<string>"
    },
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "width": 4128,
    "height": 4128,
    "owner": 123,
    "deleted": "2023-11-07T05:31:56Z",
    "framerate": 500,
    "n_frames": 1073741824,
    "bitrate": 4611686018427388000,
    "codec_id": "<string>",
    "bit_depth": 15,
    "chroma_subsampling": "<string>",
    "color_space": "<string>",
    "size": 200000000050,
    "file": "<string>",
    "thumbnail": "<string>",
    "quality_score": 3
  },
  "ml_models": [
    {
      "id": 123,
      "name": "<string>",
      "task": 1,
      "cost_weight": 123,
      "upscale_factor": 123,
      "fps_boost_factor": 123,
      "priority": 123,
      "max_resolution": 123
    }
  ],
  "codec": "libx264",
  "container": "mov",
  "crf": 123,
  "qscale": 123,
  "prores_profile": -1,
  "grain": 123,
  "stabilization_smoothing": 123,
  "preview": true,
  "fps_interpolation_factor": 123,
  "playback_speed": 123,
  "output_resolution": -1,
  "sharpen_strength": 123
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Response

​
id
integer
required
​
started
string<date-time>
required

Job's start time

​
finished
string<date-time> | null
required

Job's finished time

​
status
string
required
​
input_video
object
required
​
output_video
object
required
​
ml_models
object[]
required
​
codec
enum<string>
required

Codec used for the Enhanced video.

  • libx264 - H264
  • libx265 - HEVC/H265
  • prores_ks - Apple ProRes
Available options:
libx264,
libx265,
prores_ks
​
container
enum<string>
required

Container format of the Enhanced video.

  • mov - Mov
  • mkv - Mkv
  • mp4 - Mp4
Available options:
mov,
mkv,
mp4
​
crf
integer
required

Constant Rate Factor (CRF) is encoding quality of the output video. 23 is a good starting value. Set to 20 or lower if you need very high quality encoding (increased file size), or higher than 25 if quality is not paramount (smaller file size). Learn more about CRF.

​
qscale
integer
required

Represents the qscale parameter in ffmpeg. Used with ProRes codec. Set the value between 9 and 13 for optimal results. Learn more about Qscale

​
prores_profile
enum<integer>
required
  • -1 - Auto
  • 0 - Proxy
  • 1 - Lt
  • 2 - Standard
  • 3 - Hq
  • 4 - V4444
  • 5 - V4444Xq
Available options:
-1,
0,
1,
2,
3,
4,
5
​
grain
number<double>
required

Grain amount to add to the enhanced video in range [0, 1]. 0 is default.

​
stabilization_smoothing
integer
required

If AI Stabilization filter is enabled, this parameter controls the intensity of stabilization. Ignored if AI Stabilization is disabled. Use higher values for very shaky videos, and lower strength for less shaky videos. Video may be zoomed in if the video is very shaky.

​
preview
boolean
required

Flag which denotes if job is free preview job or not. Free preview jobs are not charged but the output video is watermarked and only a short video segment is enhanced.

​
fps_interpolation_factor
number<double>
required

Framerate interpolation factor. E.g. 1.5 means the video will have 1.5x the AI interpolated framerate. 1.0 means the framerate will not be changed. IMPORTANT: Won't be applied if the FPS BOOST model isn't passed in ml_models.

​
playback_speed
number<double>
required

Playback speed of the video. 1.0 means the video will play at normal speed. 0.5 means the video will play at half speed with AI interpolated frames in between. IMPORTANT: Won't be applied if the SLOW MOTION model isn's passed in ml_models.

​
output_resolution
enum<integer>
required
  • -1 - No Resize
  • 640 - 360p
  • 720 - SD
  • 854 - HQ
  • 1280 - 720p
  • 1920 - 1080p
  • 2048 - 2K
  • 2560 - QHD
  • 3840 - 4K
Available options:
-1,
640,
720,
854,
1280,
1920,
2048,
2560,
3840
​
sharpen_strength
number<double>
required

If AI Sharpen filter is enabled, this parameter controls the intensity of sharpening. Ignored if AI Sharpen filter is disabled.