curl --request GET \
--url https://backend.tensorpix.ai/api/jobs/ \
--header 'Authorization: <api-key>'{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"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
}
]
}Get the list of jobs. You can know when the job is finished by checking it’s status attribute. Once the job is completed, the previously null output_video attribute will be populated with the enhanced video metadata.
curl --request GET \
--url https://backend.tensorpix.ai/api/jobs/ \
--header 'Authorization: <api-key>'{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"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
}
]
}Token-based authentication with required prefix "Token"
Number of results to return per page.
The initial index from which to return the results.
123
"http://api.example.org/accounts/?offset=400&limit=100"
"http://api.example.org/accounts/?offset=200&limit=100"
Show child attributes
Job's start time
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.
Job description
Job cost in 🪙 Credits.
Job's status
0 - In Queue1 - Processing2 - Finished-1 - Failed-2 - Canceled0, 1, 2, -1, -2 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.
Job's finished time
Job's progress ratio in the range [0, 1].
Show child attributes
Media name
Width of the video in pixels
Height of the video in pixels
Date when the media was created
Number of frames in the video
Video framerate in frames per second
Size of the video in bytes
Thumbnail of the video. null if the video was enhanced with the /jobs/from-url endpoint
Video bitrate in bits per second
Bit depth of the video
Pre-signed uploaded video URL. The URL may expire after some time. To generate a new URL, call the endpoint again. If the field is null, it means the video hasn't been completely uploaded to our servers yet. The field can also be null if the video was enhanced using the /jobs/from-url endpoint. In that case the video is not stored on our servers and the field is null
Show child attributes
Media name
1024Date when the media was created
64 <= x <= 819264 <= x <= 8192User who owns this media
Datetime when the media was deleted. Null if not deleted.
Video framerate in frames per second
0 <= x <= 1000Number of frames in the video
1 <= x <= 2147483647Video bitrate in bits per second
1 <= x <= 9223372036854776000Bit depth of the video
1 <= x <= 30Size of the video in bytes
100 <= x <= 400000000000Pre-signed uploaded video URL. The URL may expire after some time. To generate a new URL, call the endpoint again. If the field is null, it means the video hasn't been completely uploaded to our servers yet. The field can also be null if the video was enhanced using the /jobs/from-url endpoint. In that case the video is not stored on our servers and the field is null
Thumbnail of the video. null if the video was enhanced with the /jobs/from-url endpoint
User rated quality score of the enhanced video. 1 is the worst, 5 the best. Null if the video is not rated yet.
1 <= x <= 5Show child attributes
Model name
Task (filter) used for video enhancement.
1 - Super Resolution2 - Film damage3 - Denoise4 - Sharpen5 - VHS Prettify6 - Dropouts Buster7 - Auto Color Balance8 - Decompressor9 - Deinterlace10 - FPS Interpolation11 - Slow Motion12 - Face Enhance13 - Stabilization14 - Audio Denoise15 - Low Light Enhance1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 Model's impact on the job cost. The higher the weight, the more the job will cost if this model is used.
Video upscale factor. E.g. 2 means the 512x512 px video becomes 1024x1024 px. Ignored if the Super Resolution model is not present.
DEPRECATED. See Job's fps_interpolation_factor. How much the video framerate will be increased. Ignored if the framerate interpolation model is not present.
ML model execution priority. Used internally to determine the order of models execution. Lower value means earlier execution.
Maximum input video resolution the ML model supports (in pixels). E.g. 4X upscale models don't support input video resolutions higher than 1280x720 px.
Grain amount to add to the enhanced video in range [0, 1]. 0 is default.
Codec used for the Enhanced video.
libx264 - H264libx265 - HEVC/H265prores_ks - Apple ProReslibx264, libx265, prores_ks -1 - No Resize640 - 360p720 - SD854 - HQ1280 - 720p1920 - 1080p2048 - 2K2560 - QHD3840 - 4K-1, 640, 720, 854, 1280, 1920, 2048, 2560, 3840 Flag which denotes if the output video will be side by side video of the original and enhanced video.
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.
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 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.
If AI Sharpen filter is enabled, this parameter controls the intensity of sharpening. Ignored if AI Sharpen filter is disabled.
Cuts the video starting from this frame before enhancing it.
Cuts the video ending on this frame before enhancing it.
Was this page helpful?