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