Video and Image Upscaling API

Apply a real estate brand kit

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

import requests

url = "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/apply-brand-kit/"

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

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/apply-brand-kit/', 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}/apply-brand-kit/",
  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([
    'brand_kit_id' => '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}/apply-brand-kit/"

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

require 'uri'
require 'net/http'

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "background_music": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "file": "<string>",
    "duration_s": 123,
    "file_size": 123,
    "bitrate": 123,
    "sample_rate": 123,
    "channels": 123
  },
  "background_music_volume": 123,
  "logo_asset": {
    "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>"
  },
  "speaker_voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "language_code": "<string>",
    "language": "<string>",
    "accent": "<string>",
    "gender": "<string>",
    "use_case": "<string>",
    "descriptive": "<string>",
    "cloned_by_count": 123,
    "description": "<string>",
    "avatar_image_url": "<string>",
    "audio_preview_url": "<string>",
    "supported_languages": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "locale": "<string>",
        "language": "<string>",
        "accent": "<string>",
        "preview_url": "<string>"
      }
    ]
  },
  "is_voiceover_enabled": true,
  "is_captions_enabled": true,
  "video_style": "just_listed",
  "video_format": "9:16",
  "model_code_name": "medium",
  "requested_output_width": 123,
  "requested_output_height": 123,
  "requested_video_aspect_ratio": "<string>",
  "requested_duration_s": 123,
  "street_address": "<string>",
  "suburb": "<string>",
  "state": "<string>",
  "country_name": "<string>",
  "city_name": "<string>",
  "num_bedrooms": 123,
  "num_bathrooms": 123,
  "num_car_parking_spots": 123,
  "num_floors": 123,
  "price_display": "<string>",
  "land_size_value": 123,
  "land_size_unit": "sqm",
  "real_estate_type": "house",
  "additional_information": "<string>",
  "intro_template_key": "<string>",
  "outro_template_key": "<string>",
  "intro_template_overrides": {},
  "outro_template_overrides": {},
  "shot_count": 123,
  "num_full_rendered_videos": 123,
  "ready_for_generation": true,
  "voiceover": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "audio_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "duration_s": 123,
      "file_size": 123,
      "bitrate": 123,
      "sample_rate": 123,
      "channels": 123
    },
    "caption_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "file": "<string>"
    },
    "text_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "text": "<string>"
    },
    "metadata": "<unknown>"
  }
}

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

apply-brand-kit

Apply a real estate brand kit

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

import requests

url = "https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/apply-brand-kit/"

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

fetch('https://backend.tensorpix.ai/api/v2/real-estate/projects/{project_id}/apply-brand-kit/', 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}/apply-brand-kit/",
  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([
    'brand_kit_id' => '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}/apply-brand-kit/"

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

require 'uri'
require 'net/http'

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "background_music": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "file": "<string>",
    "duration_s": 123,
    "file_size": 123,
    "bitrate": 123,
    "sample_rate": 123,
    "channels": 123
  },
  "background_music_volume": 123,
  "logo_asset": {
    "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>"
  },
  "speaker_voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "language_code": "<string>",
    "language": "<string>",
    "accent": "<string>",
    "gender": "<string>",
    "use_case": "<string>",
    "descriptive": "<string>",
    "cloned_by_count": 123,
    "description": "<string>",
    "avatar_image_url": "<string>",
    "audio_preview_url": "<string>",
    "supported_languages": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "locale": "<string>",
        "language": "<string>",
        "accent": "<string>",
        "preview_url": "<string>"
      }
    ]
  },
  "is_voiceover_enabled": true,
  "is_captions_enabled": true,
  "video_style": "just_listed",
  "video_format": "9:16",
  "model_code_name": "medium",
  "requested_output_width": 123,
  "requested_output_height": 123,
  "requested_video_aspect_ratio": "<string>",
  "requested_duration_s": 123,
  "street_address": "<string>",
  "suburb": "<string>",
  "state": "<string>",
  "country_name": "<string>",
  "city_name": "<string>",
  "num_bedrooms": 123,
  "num_bathrooms": 123,
  "num_car_parking_spots": 123,
  "num_floors": 123,
  "price_display": "<string>",
  "land_size_value": 123,
  "land_size_unit": "sqm",
  "real_estate_type": "house",
  "additional_information": "<string>",
  "intro_template_key": "<string>",
  "outro_template_key": "<string>",
  "intro_template_overrides": {},
  "outro_template_overrides": {},
  "shot_count": 123,
  "num_full_rendered_videos": 123,
  "ready_for_generation": true,
  "voiceover": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "audio_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "duration_s": 123,
      "file_size": 123,
      "bitrate": 123,
      "sample_rate": 123,
      "channels": 123
    },
    "caption_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "file": "<string>"
    },
    "text_asset": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "text": "<string>"
    },
    "metadata": "<unknown>"
  }
}

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

Require the brand kit to apply to an owned real-estate project.

brand_kit_id

string<uuid>

required

Response

Serializer for real estate project detail responses.

string<uuid>

required

read-only

name

string

required

read-only

Project title

description

string

required

read-only

Project description

created_at

string<date-time>

required

read-only

Datetime when the record was created.

updated_at

string<date-time>

required

read-only

Datetime when the record was last updated.

background_music

object

required

Serializer for AudioAsset with basic fields.

Show child attributes

background_music_volume

number<double>

required

read-only

Background music volume from 0.0 to 1.0.

logo_asset

object

required

Serializer for ImageAsset with basic fields.

Show child attributes

speaker_voice

object

required

Serializer for SpeakerVoiceSettings (read-only for users).

Users can view and select from available voices. Voice management is restricted to admins via Django admin.

Show child attributes

is_voiceover_enabled

boolean

required

read-only

Whether this real-estate project uses project-level voiceover.

is_captions_enabled

boolean

required

read-only

Whether this real-estate project renders captions on the video.

video_style

enum<string> | null

required

Style of the real estate video.

just_listed - Just Listed
just_sold - Just Sold
coming_soon - Coming Soon
for_rent - For Rent
price_drop - Price Drop

Available options:

just_listed,

just_sold,

coming_soon,

for_rent,

price_drop

video_format

enum<string>

required

Video aspect ratio format.

9:16 - 9:16
4:5 - 4:5
1:1 - 1:1
16:9 - 16:9

Available options:

9:16,

4:5,

1:1,

16:9

model_code_name

enum<string>

required

Public model code used for real-estate video generation.

medium - Medium
high - High
extra_high - Extra high
ultra - Ultra

Available options:

medium,

high,

extra_high,

ultra

requested_output_width

integer

required

read-only

requested_output_height

integer

required

read-only

requested_video_aspect_ratio

string

required

read-only

Run requested video aspect ratio and return the result used by the caller.

Run the main steps in order and keep side effects in this scope.

Returns: Result value returned to the caller.

requested_duration_s

number<double>

required

read-only

street_address

string

required

read-only

suburb

string

required

read-only

state

string

required

read-only

country_name

string

required

read-only

city_name

string

required

read-only

num_bedrooms

integer | null

required

read-only

num_bathrooms

integer | null

required

read-only

num_car_parking_spots

integer | null

required

read-only

num_floors

integer | null

required

read-only

price_display

string

required

read-only

land_size_value

number<double> | null

required

read-only

land_size_unit

enum<string>

required

sqm - Square Meters
sqft - Square Feet
hectares - Hectares
acres - Acres

Available options:

sqm,

sqft,

hectares,

acres

real_estate_type

enum<string>

required

house - House
townhome - Townhome
apartment - Apartment
condo - Condo
villa - Villa
land - Land
commercial - Commercial
other - Other

Available options:

house,

townhome,

apartment,

condo,

villa,

land,

commercial,

other

additional_information

string

required

read-only

intro_template_key

string

required

read-only

outro_template_key

string

required

read-only

intro_template_overrides

object

required

read-only

Return intro overrides with declared image UUIDs expanded to assets.

Show child attributes

outro_template_overrides

object

required

read-only

Return outro overrides with declared image UUIDs expanded to assets.

Show child attributes

shot_count

integer

required

read-only

num_full_rendered_videos

integer

required

read-only

ready_for_generation

boolean

required

read-only

Return the ready for generation value for the current request flow.

Run the main steps in order and keep side effects in this scope.

Args: obj: Input value used by this function.

Returns: Result value returned to the caller.

voiceover

object

required

Serializer for VoiceoverAsset with nested audio and text.

Show child attributes