Decluttering API
The decluttering service allows you to automatically remove unwanted objects from your interior photos, creating cleaner and more attractive spaces for your real estate listings.Generate a decluttered image
Calling this endpoint launches a new generation to declutter an image. This endpoint also creates a new project; depending on your subscription, it is possible to obtain free variations on the same project. As generation can take several minutes, the result is not immediately available. You can either provide a webhook URL or regularly query the retrieval API.Request Parameters
Automatic treatment applied to the whole image, without a mask:
empty to empty the room of its furniture and decoration, tidy to tidy it up by removing clutter, trinkets, small objects, books and decorative items. Cannot be combined with mask_url.Legacy alias for
mode: "empty". If set to true, the AI automatically detects and removes objects on the whole image. Otherwise, you must provide a mask.URL of the mask (png) indicating areas to declutter. Required when you provide neither
mode nor auto: true.The URL we call once the generation is complete. The request body is the same as the response from the retrieval API
mode or auto: true) and the masked treatment (mask_url) are mutually exclusive. The request is rejected with a 400 status if you provide both mode and mask_url, or none of the three (mode, auto: true, mask_url).
Response
Request Example
Response Example
Generate a variation of a decluttered image
Calling this endpoint allows you to generate a variation of a previously decluttered image, optionally specifying a new mask. As generation can take several minutes, the result is not immediately available. Important note: a variation replays the treatment of the parent generation. Themode (or auto) of the original generation is reused automatically; the mode and auto fields sent in the request body are ignored. To get a different treatment, start a new generation.
Request Parameters
URL of the mask indicating areas to declutter. Only required if the parent generation used a mask and you want to change it: without it, the parent generation’s mask is reused. Ignored if the parent generation was automatic (
mode or auto: true).