Skip to main content
GET
Get a real estate project

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

project_id
string<uuid>
required

Response

Serializer for real estate project detail responses.

id
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.

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.

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.

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.

ai_generated_text
string | null
required
read-only

Optional text shown in the bottom-left corner of the final 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

Aspect ratio computed from the requested output width and height.

duration_s
number<double>
required
read-only

Final timeline duration after shot speed and transition overlap.

requested_duration_s
number<double>
required
read-only

Legacy read only alias for duration_s.

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
number<double> | null
required
read-only
num_bathrooms
number<double> | 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 - m²
  • sqft - sqft
  • hectares - ha
  • acres - ac
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

Validated intro template values with image IDs expanded to image assets.

outro_template_overrides
object
required
read-only

Validated outro template values with image IDs expanded to image assets.

shot_count
integer
required
read-only

Number of ordered shots in the project.

num_full_rendered_videos
integer
required
read-only

Number of saved final project renders.

ready_for_generation
boolean
required
read-only

Whether the project has the media required for a full video job.

ready_for_render
boolean
required
read-only

Whether each shot has a selected video or first frame and no render job is active.

voiceover
object
required

Saved voiceover text, audio, captions, and metadata for this project.