Video and Image Upscaling API

Create a real estate render job

curl --request POST \
  --url https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 25,
  "chroma_subsampling": "<string>",
  "grain": 0.5,
  "composition_fps": 60,
  "background_music_volume": 0.5
}
'

import requests

url = "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/"

payload = {
    "output_container": "<string>",
    "output_video_codec": "<string>",
    "output_audio_codec": "<string>",
    "output_crf": 25,
    "chroma_subsampling": "<string>",
    "grain": 0.5,
    "composition_fps": 60,
    "background_music_volume": 0.5
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    output_container: '<string>',
    output_video_codec: '<string>',
    output_audio_codec: '<string>',
    output_crf: 25,
    chroma_subsampling: '<string>',
    grain: 0.5,
    composition_fps: 60,
    background_music_volume: 0.5
  })
};

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'output_container' => '<string>',
    'output_video_codec' => '<string>',
    'output_audio_codec' => '<string>',
    'output_crf' => 25,
    'chroma_subsampling' => '<string>',
    'grain' => 0.5,
    'composition_fps' => 60,
    'background_music_volume' => 0.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/"

	payload := strings.NewReader("{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "status": "queued",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "processing_time_seconds": 123,
  "cost_credits": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preset": "render_preview",
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 123,
  "chroma_subsampling": "<string>",
  "grain": 123,
  "composition_width": 123,
  "composition_height": 123,
  "composition_fps": 123,
  "background_music_volume": 123
}

{
  "detail": "<unknown>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "status": "queued",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "processing_time_seconds": 123,
  "cost_credits": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preset": "render_preview",
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 123,
  "chroma_subsampling": "<string>",
  "grain": 123,
  "composition_width": 123,
  "composition_height": 123,
  "composition_fps": 123,
  "background_music_volume": 123
}

POST

api

real-estate

projects

{project_id}

render-jobs

Create a real estate render job

curl --request POST \
  --url https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 25,
  "chroma_subsampling": "<string>",
  "grain": 0.5,
  "composition_fps": 60,
  "background_music_volume": 0.5
}
'

import requests

url = "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/"

payload = {
    "output_container": "<string>",
    "output_video_codec": "<string>",
    "output_audio_codec": "<string>",
    "output_crf": 25,
    "chroma_subsampling": "<string>",
    "grain": 0.5,
    "composition_fps": 60,
    "background_music_volume": 0.5
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    output_container: '<string>',
    output_video_codec: '<string>',
    output_audio_codec: '<string>',
    output_crf: 25,
    chroma_subsampling: '<string>',
    grain: 0.5,
    composition_fps: 60,
    background_music_volume: 0.5
  })
};

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'output_container' => '<string>',
    'output_video_codec' => '<string>',
    'output_audio_codec' => '<string>',
    'output_crf' => 25,
    'chroma_subsampling' => '<string>',
    'grain' => 0.5,
    'composition_fps' => 60,
    'background_music_volume' => 0.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/"

	payload := strings.NewReader("{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/render-jobs/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"output_container\": \"<string>\",\n  \"output_video_codec\": \"<string>\",\n  \"output_audio_codec\": \"<string>\",\n  \"output_crf\": 25,\n  \"chroma_subsampling\": \"<string>\",\n  \"grain\": 0.5,\n  \"composition_fps\": 60,\n  \"background_music_volume\": 0.5\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "status": "queued",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "processing_time_seconds": 123,
  "cost_credits": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preset": "render_preview",
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 123,
  "chroma_subsampling": "<string>",
  "grain": 123,
  "composition_width": 123,
  "composition_height": 123,
  "composition_fps": 123,
  "background_music_volume": 123
}

{
  "detail": "<unknown>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "status": "queued",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "processing_time_seconds": 123,
  "cost_credits": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preset": "render_preview",
  "output_container": "<string>",
  "output_video_codec": "<string>",
  "output_audio_codec": "<string>",
  "output_crf": 123,
  "chroma_subsampling": "<string>",
  "grain": 123,
  "composition_width": 123,
  "composition_height": 123,
  "composition_fps": 123,
  "background_music_volume": 123
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

project_id

string<uuid>

required

Body

Create one real-estate project Shotstack render job.

preset

Render quality preset. When set, provides default values for output settings.

render_preview - Render Preview
render_full - Render Full

Available options:

render_preview,

render_full

output_container

string

Output container format (e.g., 'mp4', 'webm', 'mov').

Maximum string length: 20

output_video_codec

string

Video codec (e.g., 'h264', 'h265', 'vp9').

Maximum string length: 20

output_audio_codec

string

Audio codec (e.g., 'aac', 'mp3', 'opus').

Maximum string length: 20

output_crf

integer

Constant Rate Factor for video quality (0=lossless, 51=worst). Lower is better quality.

Required range: 0 <= x <= 51

chroma_subsampling

string

Pixel format (e.g., 'yuv420p', 'yuv444p').

Maximum string length: 20

grain

number<double>

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

Required range: 0 <= x <= 1

composition_fps

integer

Output video framerate (frames per second).

Required range: 1 <= x <= 120

background_music_volume

number<double>

Background music volume level in range [0.0, 1.0]. 0.0 is muted, 1.0 is full volume.

Required range: 0 <= x <= 1

Response

Read one real-estate render job.

string<uuid>

required

read-only

created_at

string<date-time>

required

read-only

Datetime when the record was created.

error_message

string

required

read-only

Error details if job failed.

status

enum<string>

required

Current job status.

queued - Queued
processing - Processing
expired - Expired
cancelled - Cancelled
completed - Completed
failed - Failed

Available options:

queued,

processing,

expired,

cancelled,

completed,

failed

description

string

required

read-only

Human-readable job description.

started_at

string<date-time>

required

read-only

When job processing started.

finished_at

string<date-time> | null

required

read-only

When the job processing successfully finished.

processing_time_seconds

number<double>

required

read-only

Calculate job processing time in seconds. If the job is still processing, calculate time since started. If the job was cancelled, deleted, calculate time until that point. if the job is completed, calculate time until finished.

cost_credits

string<decimal>

required

read-only

Job cost in 🪙 Credits.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

project

string<uuid> | null

required

read-only

Project this render job belongs to.

shot

string<uuid> | null

required

read-only

Shot this render job belongs to.

project_real_estate

string<uuid> | null

required

read-only

Real-estate project this render job belongs to.

preset

enum<string> | null

required

Render quality preset. When set, provides default values for output settings.

render_preview - Render Preview
render_full - Render Full

Available options:

render_preview,

render_full

output_container

string

required

read-only

Output container format (e.g., 'mp4', 'webm', 'mov').

output_video_codec

string

required

read-only

Video codec (e.g., 'h264', 'h265', 'vp9').

output_audio_codec

string

required

read-only

Audio codec (e.g., 'aac', 'mp3', 'opus').

output_crf

integer

required

read-only

Constant Rate Factor for video quality (0=lossless, 51=worst). Lower is better quality.

chroma_subsampling

string

required

read-only

Pixel format (e.g., 'yuv420p', 'yuv444p').

grain

number<double>

required

read-only

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

composition_width

integer

required

read-only

Output video width in pixels.

composition_height

integer

required

read-only

Output video height in pixels.

composition_fps

integer

required

read-only

Output video framerate (frames per second).

background_music_volume

number<double>

required

read-only

Background music volume level in range [0.0, 1.0]. 0.0 is muted, 1.0 is full volume.