Exterior Creation API
The Exterior Creation service allows you to generate realistic visualizations of outdoor spaces from a designated area in an image.Generate an exterior creation
This endpoint initiates a new generation to create an outdoor space in an area specified by a mask. This operation also creates a new project.Request Parameters
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
string
required
URL of the base image for creation (format: jpg, png)
string
required
URL of the mask indicating the area where the exterior should be generated
string
required
Type of exterior to generate. Possible values: “TERRACE”, “POOL”, “PETANQUE”
number
required
Width of the image in pixels
number
required
Height of the image in pixels
string
The URL we call once the generation is complete
Response
string
The unique generation identifier (UUID) to use with the retrieval API
number
The number of photos remaining after this generation
string
The unique project identifier (UUID)
Request Example
Response Example
Generate an exterior variation
This endpoint allows you to generate a variation of a previously created exterior space.Request Parameters
string
required
The unique user identifier (UUID)
string
required
The unique identifier of the previous generation
string
required
URL of the original image used for the previous generation
string
Optional URL of a new mask. If not provided, the mask from the previous generation will be used
string
required
Type of exterior for this variation. Possible values: “TERRACE”, “POOL”, “PETANQUE”
string
The URL we call once the generation is complete
Response
string
The unique identifier of the new generation
Request Example
Response Example
Retrieve an exterior creation
This endpoint allows you to obtain the result of a previously performed generation.Request Parameters
string
required
The unique user identifier (UUID)
string
required
The unique identifier of the generation to retrieve
Response
string
The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
array
An array containing the URLs of generated images (present only if status=“SUCCEEDED”)
number
The number of variations already performed on this project