Exterior Improvement API
The exterior improvement service allows you to virtually transform the appearance of buildings, gardens, terraces, and other outdoor spaces.Generate an exterior improvement
Request Parameters
string
required
The unique user identifier (UUID)
string
required
URL of the outdoor space image to transform
string
required
The type of outdoor space to improve. Accepted values: JARDIN, GAZON, POOL, BALCON, TERRACE.
boolean
If enabled, preserves the building facade (optional)
boolean
If enabled, adds a blue sky to the image (optional)
string
Webhook URL for notifications (optional)
Available values for room_type
The following values are accepted for theroom_type parameter:
JARDIN- Garden with flowers and plantsGAZON- Green lawnPOOL- Garden with swimming poolBALCON- Balcony or small terraceTERRACE- Larger terrace
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 type of outdoor space to improve. Accepted values: JARDIN, GAZON, POOL, BALCON, TERRACE.
boolean
If enabled, preserves the building facade (optional)
boolean
If enabled, adds a blue sky to the image (optional)
string
Webhook URL for notifications (optional)
Response
string
The unique identifier of the new generation (UUID)
Request Example
Response Example
Retrieve an exterior improvement
Request Parameters
string
required
The unique user identifier (UUID)
string
required
The unique generation identifier (UUID) returned by the
/api/exterior/v2/generate or /api/exterior/v2/generate-variation endpointResponse
The endpoint returns the generation status and the URLs of the resulting images when processing is complete.string
Generation status: “starting”, “in_progress”, “succeeded”, “failed”
string
URL of the transformed image (only present if status=“succeeded”)
