Furnishing API
The furnishing service allows you to virtually furnish empty spaces or replace existing furniture in your images.Generate a furnishing
POST /api/furnish/v3/generate
Request Parameters
The unique user identifier (UUID)
URL of the space image to furnish
The desired furnishing theme. Accepted values: MODERN, SCANDINAVIAN, COASTAL,
FARMHOUSE, LUXURY, AMERICAN.
The type of room to furnish. Accepted values: LIVING_ROOM, BEDROOM, DINING,
HOME_OFFICE, KIDS, OUTDOOR.
Webhook URL for notifications (optional)
Available values for room_type
The following values are accepted for theroom_type
parameter:
LIVING_ROOM
- Living roomBEDROOM
- BedroomDINING
- Dining roomHOME_OFFICE
- Home officeKIDS
- Kids roomOUTDOOR
- Outdoor space
Available values for theme
The following values are accepted for thetheme
parameter:
MODERN
- Modern styleSCANDINAVIAN
- Scandinavian styleCOASTAL
- Coastal styleFARMHOUSE
- Farmhouse styleLUXURY
- Luxury styleAMERICAN
- American style
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
POST /api/furnish/v3/generate-variation
Request Parameters
The unique user identifier (UUID)
The identifier of the previous generation you want to create a variation of
The desired furnishing theme. Accepted values: MODERN, SCANDINAVIAN, COASTAL,
FARMHOUSE, LUXURY, AMERICAN.
The type of room to furnish. Accepted values: LIVING_ROOM, BEDROOM, DINING,
HOME_OFFICE, KIDS, OUTDOOR.
Webhook URL for notifications (optional)
Response
The unique identifier of the new generation (UUID)
Request Example
Response Example
Retrieve a furnishing
POST /api/furnish/v3/get
Request Parameters
The unique user identifier (UUID)
The unique generation identifier (UUID) returned by the
/api/furnish/v3/generate
or /api/furnish/v3/generate-variation
endpointResponse
The endpoint returns the generation status and the URLs of the resulting images when processing is complete.Generation status: “starting”, “in_progress”, “succeeded”, “failed”
URLs of the furnished images (only present if status=“succeeded”)
Variation number (optional)