Skip to main content

​
Renovation API

The renovation service allows you to visualize how a space might appear after renovation work, without performing the actual renovations.

​
Generate a renovation

​

​
Request Parameters

​
string
required
The unique user identifier (UUID)
​
string
required
URL of the image of the space to be renovated
​
string
required
The desired decoration theme for the renovation. Accepted values: MODERN, SCANDINAVIAN, INDUSTRIAL, LUXURIOUS, FARMHOUSE_CHIC, KIDS_ROOM (for BEDROOM only), MODERN_POP (for LIVING_ROOM and VERANDA only).
​
string
required
The room type. Accepted values: LIVING_ROOM, BEDROOM, BATHROOM, SHOWEROOM, HOME_OFFICE, EMPTY, VERANDA, KITCHEN, DINING_ROOM.
​
boolean
If the image is a 360° panoramic photo
​
boolean
Preserve the original ceiling
​
boolean
Preserve the original floor
​
boolean
Preserve the original walls
​
boolean
Preserve the original doors
​
boolean
Preserve the original windows (enabled by default)
​
boolean
Furnish the renovated room. Works only with: BEDROOM, DINING_ROOM, LIVING_ROOM, HOME_OFFICE.
​
string
Webhook URL for notifications (optional)

​
Available values for room_type

The following values are accepted for the room_type parameter:
  • LIVING_ROOM - Living room
  • BEDROOM - Bedroom
  • BATHROOM - Bathroom
  • SHOWEROOM - Shower room
  • HOME_OFFICE - Home office
  • EMPTY - Empty room
  • VERANDA - Veranda
  • KITCHEN - Kitchen
  • DINING_ROOM - Dining room

​
Available values for theme

The following values are accepted for the theme parameter (note that not all themes are available for all room types):
  • MODERN - Modern style
  • SCANDINAVIAN - Scandinavian style
  • INDUSTRIAL - Industrial style
  • LUXURIOUS - Luxurious style
  • FARMHOUSE_CHIC - Farmhouse/rustic style
  • KIDS_ROOM - Kids room (for BEDROOM type only)
  • MODERN_POP - Colorful modern style (only for LIVING_ROOM and VERANDA)

​
Rooms compatible with the furnish option

The furnish option works only with the following room types:
  • BEDROOM
  • DINING_ROOM
  • LIVING_ROOM
  • HOME_OFFICE

​
Response

​
string
The unique generation identifier (UUID)
​
number
The number of photo credits remaining for the user
​
string
The unique project identifier (UUID)

​
Request Example

​
Response Example

​
Generate a variation

​
This API allows you to generate variations from a previous result.

​
Request Parameters

​
string
required
The unique user identifier (UUID)
​
string
required
The identifier of the previous generation you want to create a variation of
​
string
required
The new desired decoration theme. Accepted values: MODERN, SCANDINAVIAN, INDUSTRIAL, LUXURIOUS, FARMHOUSE_CHIC, KIDS_ROOM (for BEDROOM only), MODERN_POP (for LIVING_ROOM and VERANDA only).
​
string
required
The room type. Accepted values: LIVING_ROOM, BEDROOM, BATHROOM, SHOWEROOM, HOME_OFFICE, EMPTY, VERANDA, KITCHEN, DINING_ROOM.
​
boolean
If the image is a 360° panoramic photo
​
boolean
Preserve the original ceiling
​
boolean
Preserve the original floor
​
boolean
Preserve the original walls
​
boolean
Preserve the original doors
​
boolean
Preserve the original windows (enabled by default)
​
boolean
Furnish the renovated room. Works only with: BEDROOM, DINING_ROOM, LIVING_ROOM, HOME_OFFICE.
​
string
Webhook URL for notifications (optional)

​
Response