Skip to main content
GET
/
api
/
jobs
/
{id}
Get job details
curl --request GET \
  --url https://backend.tensorpix.ai/api/jobs/{id}/ \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "started": "2023-11-07T05:31:56Z",
  "preview": true,
  "description": "<string>",
  "cost_usd": "<string>",
  "status": 0,
  "eta_s": 123,
  "finished": "2023-11-07T05:31:56Z",
  "processing_progress": 123,
  "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
    }
  ],
  "grain": 123,
  "codec": "libx264",
  "output_resolution": -1,
  "comparison": true,
  "stabilization_smoothing": 123,
  "fps_interpolation_factor": 123,
  "playback_speed": 123,
  "sharpen_strength": 123,
  "start_frame": 123,
  "end_frame": 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

​
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.

​
description
string
required

Job description

​
cost_usd
string<decimal>
required

Job cost in 🪙 Credits.

​
status
enum<integer>
required

Job's status

  • 0 - In Queue
  • 1 - Processing
  • 2 - Finished
  • -1 - Failed
  • -2 - Canceled
Available options:
0,
1,
2,
-1,
-2
​
eta_s
number<double>
required

Job's estimated time of arrival in seconds. ETA is only an approximation and it can flactuate a lot. ETA is usually more accurate when the job is longer and has been running for a while.

​
finished
string<date-time> | null
required

Job's finished time

​
processing_progress
number<double>
required

Job's progress ratio in the range [0, 1].

​
input_video
object
required
​
output_video
object
required
​
ml_models
object[]
required
​
grain
number<double>
required

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

​
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
​
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
​
comparison
boolean
required

Flag which denotes if the output video will be side by side video of the original and enhanced video.

​
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.

​
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.

​
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.

​
start_frame
integer | null
required

Cuts the video starting from this frame before enhancing it.

​
end_frame
integer | null
required

Cuts the video ending on this frame before enhancing it.