Enhance uploaded video

curl --request POST \
  --url https://backend.tensorpix.ai/api/jobs/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ml_models": [
    123
  ],
  "codec": "libx264",
  "crf": 25,
  "qscale": 16,
  "container": "mov",
  "chroma_subsampling": "yuv420p",
  "preview": true,
  "start_frame": 1073741823,
  "end_frame": 1073741824,
  "input_video": 123,
  "output_video": 123,
  "output_resolution": -1,
  "grain": 0.5,
  "comparison": true,
  "stabilization_smoothing": 20,
  "target_fps": 120.5,
  "playback_speed": 0.55,
  "sharpen_strength": 5,
  "prores_profile": -1
}
'

{
  "id": 123,
  "owner": "[email protected]",
  "ml_models": [
    123
  ],
  "cost_usd": "<string>",
  "codec": "libx264",
  "crf": 25,
  "qscale": 16,
  "container": "mov",
  "chroma_subsampling": "yuv420p",
  "preview": true,
  "start_frame": 1073741823,
  "end_frame": 1073741824,
  "input_video": 123,
  "output_video": 123,
  "output_resolution": -1,
  "grain": 0.5,
  "comparison": true,
  "stabilization_smoothing": 20,
  "target_fps": 120.5,
  "playback_speed": 0.55,
  "sharpen_strength": 5,
  "prores_profile": -1
}

jobs

Enhance uploaded video

Enhance the uploaded video. To upload the video, use the upload videos endpoint. After the video is uploaded, use this endpoint to start the video enhancing job. Make sure to set the input_video attribute to the uploaded video’s ID which is returned in the response of the upload videos endpoint.

AI filters

AI filters are called ml-models in the API docs as they are actually machine learning models.

See the /api/ml-models to learn more about ML models selection. After choosing the appropriate models, pass the list of their IDs in the ml_models parameter. You should pass at least one AI filter.

Free Preview Jobs

Free Previews will process a short segment of the video (10sec) and won’t cost any 🪙 Credits. To enable Free Previews in a job, set the preview = True.

You can use the start_frame to set the starting frame of the Free Preview segment. end_frame parameter is ignored if preview = True.

Enhancing specific video segments

To process a whole video, don’t specify start_frame and end_frame and set preview = False.

To process a specific video segment, set the start_frame to the starting frame of the segment, and end_frame to the end frame of the segment. end_frame must be > start_frame.

Stabilization

stabilization_smoothing parameter is ignored unless the AI Stabilization Filter is set as one of the ML models.

Sharpening

sharpen_strength parameter is ignored unless the AI Sharpen Filter is set as one of the ML models.

Post enhancing clean-up

⚠️ IMPORTANT: Your account will be limited by the total storage of all enhanced and uploaded videos. While this limit will be set to a high number (1TB+), we highly recommend you delete the enhanced video after the enhanced video is copied to your server. This ensures you won’t run into storage limit errors in the future.

POST

api

jobs

Enhance uploaded video

curl --request POST \
  --url https://backend.tensorpix.ai/api/jobs/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ml_models": [
    123
  ],
  "codec": "libx264",
  "crf": 25,
  "qscale": 16,
  "container": "mov",
  "chroma_subsampling": "yuv420p",
  "preview": true,
  "start_frame": 1073741823,
  "end_frame": 1073741824,
  "input_video": 123,
  "output_video": 123,
  "output_resolution": -1,
  "grain": 0.5,
  "comparison": true,
  "stabilization_smoothing": 20,
  "target_fps": 120.5,
  "playback_speed": 0.55,
  "sharpen_strength": 5,
  "prores_profile": -1
}
'

{
  "id": 123,
  "owner": "[email protected]",
  "ml_models": [
    123
  ],
  "cost_usd": "<string>",
  "codec": "libx264",
  "crf": 25,
  "qscale": 16,
  "container": "mov",
  "chroma_subsampling": "yuv420p",
  "preview": true,
  "start_frame": 1073741823,
  "end_frame": 1073741824,
  "input_video": 123,
  "output_video": 123,
  "output_resolution": -1,
  "grain": 0.5,
  "comparison": true,
  "stabilization_smoothing": 20,
  "target_fps": 120.5,
  "playback_speed": 0.55,
  "sharpen_strength": 5,
  "prores_profile": -1
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

ml_models

integer[]

required

codec

enum<string>

Codec used for the Enhanced video.

libx264 - H264
libx265 - HEVC/H265
prores_ks - Apple ProRes

Available options:

libx264,

libx265,

prores_ks

crf

integer

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.

Required range: 0 <= x <= 51

qscale

integer

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

Required range: 0 <= x <= 32

container

enum<string>

Container format of the Enhanced video.

mov - Mov
mkv - Mkv
mp4 - Mp4

Available options:

mov,

mkv,

mp4

chroma_subsampling

yuv420p - 8-bit 4:2:0
yuv422p - 8-bit 4:2:2
yuv444p - 8-bit 4:4:4
yuv420p10le - 10-bit 4:2:0
yuv422p10le - 10-bit 4:2:2
yuv444p10le - 10-bit 4:4:4

Available options:

yuv420p,

yuv422p,

yuv444p,

yuv420p10le,

yuv422p10le,

yuv444p10le

preview

boolean

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.

start_frame

integer | null

Cuts the video starting from this frame before enhancing it.

Required range: 0 <= x <= 2147483647

end_frame

integer | null

Cuts the video ending on this frame before enhancing it.

Required range: 1 <= x <= 2147483647

input_video

integer | null

output_video

integer | null

Once the job is finished, the output_video attribute will be populated with the enhanced video metadata. If the job is canceled or it fails, the output_video attribute will remain null.

output_resolution

enum<integer>

-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

Required range: -2147483648 <= x <= 2147483647

grain

number<double>

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

Required range: 0 <= x <= 1

comparison

boolean

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

stabilization_smoothing

integer

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.

Required range: 0 <= x <= 40

target_fps

number<double>

Target FPS for the enhanced video. If not provided, the original FPS will be used. If provided, should be greater than or equal to the original FPS. If lower, it will be set to the original FPS. IMPORTANT: Won't be applied if the FPS BOOST model isn't passed in ml_models.

Required range: 1 <= x <= 240

playback_speed

number<double>

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.

Required range: 0.1 <= x <= 1

sharpen_strength

number<double>

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

Required range: 0 <= x <= 10

prores_profile

enum<integer>

-1 - Auto
0 - Proxy
1 - Lt
2 - Standard
3 - Hq
4 - V4444
5 - V4444Xq

Available options:

-1,

0,

1,

2,

3,

4,

5

Required range: -2147483648 <= x <= 2147483647

Response

integer

required

owner

string<email>

required

ml_models

integer[]

required

cost_usd

string<decimal>

required

Job cost in 🪙 Credits.

codec

enum<string>

Codec used for the Enhanced video.

libx264 - H264
libx265 - HEVC/H265
prores_ks - Apple ProRes

Available options:

libx264,

libx265,

prores_ks

crf

integer

Required range: 0 <= x <= 51

qscale

integer

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

Required range: 0 <= x <= 32

container

enum<string>

Container format of the Enhanced video.

mov - Mov
mkv - Mkv
mp4 - Mp4

Available options:

mov,

mkv,

mp4

chroma_subsampling

yuv420p - 8-bit 4:2:0
yuv422p - 8-bit 4:2:2
yuv444p - 8-bit 4:4:4
yuv420p10le - 10-bit 4:2:0
yuv422p10le - 10-bit 4:2:2
yuv444p10le - 10-bit 4:4:4

Available options:

yuv420p,

yuv422p,

yuv444p,

yuv420p10le,

yuv422p10le,

yuv444p10le

preview

boolean

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.

start_frame

integer | null

Cuts the video starting from this frame before enhancing it.

Required range: 0 <= x <= 2147483647

end_frame

integer | null

Cuts the video ending on this frame before enhancing it.

Required range: 1 <= x <= 2147483647

input_video

integer | null

output_video

integer | null

Once the job is finished, the output_video attribute will be populated with the enhanced video metadata. If the job is canceled or it fails, the output_video attribute will remain null.

output_resolution

enum<integer>

-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

Required range: -2147483648 <= x <= 2147483647

grain

number<double>

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

Required range: 0 <= x <= 1

comparison

boolean

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

stabilization_smoothing

integer

Required range: 0 <= x <= 40

target_fps

number<double>

Required range: 1 <= x <= 240

playback_speed

number<double>

Required range: 0.1 <= x <= 1

sharpen_strength

number<double>

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

Required range: 0 <= x <= 10

prores_profile

enum<integer>

-1 - Auto
0 - Proxy
1 - Lt
2 - Standard
3 - Hq
4 - V4444
5 - V4444Xq

Available options:

-1,

0,

1,

2,

3,

4,

5

Required range: -2147483648 <= x <= 2147483647

List jobs Get job details

⌘I

Endpoints

Authorizations

Body

Response