Video and Image Upscaling API

Create a real estate shot batch

curl --request POST \
  --url https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/shot-batches/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_asset_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

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

payload = { "image_asset_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
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({image_asset_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/shot-batches/', 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}/shot-batches/",
  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([
    'image_asset_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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}/shot-batches/"

	payload := strings.NewReader("{\n  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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}/shot-batches/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "image": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "first_frame": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "original_first_frame": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "animation_prompt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "text": "<string>"
    },
    "vfx_prompt": "<string>",
    "description_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "camera_movement": "auto",
    "status": "generation_requested",
    "requested_duration_s": 123,
    "requested_duration_mode": "auto",
    "crop_x": 123,
    "crop_y": 123,
    "crop_width": 123,
    "crop_height": 123,
    "video_start_time_s": 123,
    "video_end_time_s": 123,
    "selected_video": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "name_tag": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "external_url": "<string>",
      "thumbnail": "<string>",
      "last_frame": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "num_frames": 123,
      "framerate": 123,
      "duration_s": 123,
      "bitrate": 123,
      "codec_id": "<string>",
      "bit_depth": 123,
      "chroma_subsampling": "<string>",
      "color_space": "<string>"
    },
    "rendered_video": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "name_tag": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "external_url": "<string>",
      "thumbnail": "<string>",
      "last_frame": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "num_frames": 123,
      "framerate": 123,
      "duration_s": 123,
      "bitrate": 123,
      "codec_id": "<string>",
      "bit_depth": 123,
      "chroma_subsampling": "<string>",
      "color_space": "<string>"
    }
  }
]

{
  "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"
}

POST

api

real-estate

projects

{project_id}

shot-batches

Create a real estate shot batch

curl --request POST \
  --url https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/shot-batches/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_asset_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

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

payload = { "image_asset_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
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({image_asset_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/shot-batches/', 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}/shot-batches/",
  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([
    'image_asset_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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}/shot-batches/"

	payload := strings.NewReader("{\n  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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}/shot-batches/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"image_asset_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_real_estate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "image": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "first_frame": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "original_first_frame": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "thumbnail": "<string>",
      "external_url": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "tags": [
        "<string>"
      ],
      "name_tag": "<string>"
    },
    "animation_prompt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "text": "<string>"
    },
    "vfx_prompt": "<string>",
    "description_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "camera_movement": "auto",
    "status": "generation_requested",
    "requested_duration_s": 123,
    "requested_duration_mode": "auto",
    "crop_x": 123,
    "crop_y": 123,
    "crop_width": 123,
    "crop_height": 123,
    "video_start_time_s": 123,
    "video_end_time_s": 123,
    "selected_video": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "name_tag": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "external_url": "<string>",
      "thumbnail": "<string>",
      "last_frame": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "num_frames": 123,
      "framerate": 123,
      "duration_s": 123,
      "bitrate": 123,
      "codec_id": "<string>",
      "bit_depth": 123,
      "chroma_subsampling": "<string>",
      "color_space": "<string>"
    },
    "rendered_video": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "name_tag": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "external_url": "<string>",
      "thumbnail": "<string>",
      "last_frame": "<string>",
      "width": 123,
      "height": 123,
      "file_size": 123,
      "num_frames": 123,
      "framerate": 123,
      "duration_s": 123,
      "bitrate": 123,
      "codec_id": "<string>",
      "bit_depth": 123,
      "chroma_subsampling": "<string>",
      "color_space": "<string>"
    }
  }
]

{
  "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"
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

project_id

string<uuid>

required

Body

Create real-estate shots from existing project image assets.

image_asset_ids

string<uuid>[]

required

Required array length: 1 - 60 elements

Response

string<uuid>

required

read-only

project_real_estate

string<uuid>

required

read-only

Real-estate project this shot belongs to.

order

integer

required

read-only

created_at

string<date-time>

required

read-only

Datetime when the record was created.

image

object | null

required

Serializer for ImageAsset with basic fields.

Show child attributes

first_frame

object

required

Serializer for ImageAsset with basic fields.

Show child attributes

original_first_frame

object

required

Serializer for ImageAsset with basic fields.

Show child attributes

animation_prompt

object

required

Serializer for TextAsset with basic fields.

Show child attributes

vfx_prompt

string

required

read-only

Original VFX prompt sent by the client for this shot.

description_job

string<uuid>

required

read-only

camera_movement

enum<string>

required

Camera motion directive used for real-estate shot video generation.

auto - Auto
static - Static
pan_left - Pan Left
pan_right - Pan Right
orbit_left_to_right - Orbit Left To Right
orbit_right_to_left - Orbit Right To Left
truck_left - Truck Left
truck_right - Truck Right
dolly_in - Dolly In
dolly_out - Dolly Out
tilt_up - Tilt Up
tilt_down - Tilt Down

Available options:

auto,

static,

pan_left,

pan_right,

orbit_left_to_right,

orbit_right_to_left,

truck_left,

truck_right,

dolly_in,

dolly_out,

tilt_up,

tilt_down

status

enum<string>

required

Whether this shot needs new video generation or can reuse the current selected video.

generation_requested - Generation Requested
generated - Generated

Available options:

generation_requested,

generated

requested_duration_s

number<double>

required

read-only

Return the selected trim duration or the default when timing is incomplete.

requested_duration_mode

enum<string>

required

Whether requested_duration_s came from auto or manual input.

auto - Auto
manual - Manual

Available options:

auto,

manual

crop_x

number<double> | null

required

read-only

Saved crop left coordinate in relative image units from 0.0 to 1.0.

crop_y

number<double> | null

required

read-only

Saved crop top coordinate in relative image units from 0.0 to 1.0.

crop_width

number<double> | null

required

read-only

Saved crop width in relative image units from 0.0 to 1.0.

crop_height

number<double> | null

required

read-only

Saved crop height in relative image units from 0.0 to 1.0.

video_start_time_s

number<double>

required

read-only

Start time in seconds of the whole shot composition.

video_end_time_s

number<double> | null

required

read-only

End time in seconds of the whole shot composition.

selected_video

object

required

Serializer for VideoAsset with basic fields.

Show child attributes

rendered_video

object

required

Serializer for VideoAsset with basic fields.

Show child attributes