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

string

required

The unique user identifier (UUID) that you can retrieve from your Developer Space

string

required

URL of the image you want to declutter (format: jpg, png)

string

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.

boolean

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.

string

URL of the mask (png) indicating areas to declutter. Required when you provide neither mode nor auto: true.

string

The URL we call once the generation is complete. The request body is the same as the response from the retrieval API

Important note: the automatic treatment (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

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

curl --request POST \
--url 'https://iacrea.com/api/declutter_total/generate' \
--header x-api-key:API_KEY \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "image_url": "https://my-image-url.jpg",
  "mode": "empty"
}'

Response Example

{
  "generation_id": "uuid",
  "remaining_photos": 100,
  "project_id": "uuid"
}

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. The mode (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

string

required

The unique user identifier (UUID) that you can retrieve from your Developer Space

string

required

The unique identifier of the previous generation you want to create a variation of

string

required

URL of the original image to declutter

string

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).

Response

string

The unique identifier of the new generation (UUID) to use with the retrieval API

number

The number of photos remaining after this generation

Request Example

curl --request POST \
--url 'https://iacrea.com/api/declutter_total/generate-variation' \
--header x-api-key:API_KEY \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid",
  "original_url": "https://my-image-url.jpg"
}'

Response Example

{
  "generation_id": "uuid",
  "remaining_photos": 100
}

Retrieve a decluttered image

This endpoint allows you to obtain the result of a previously performed generation. It lets you know the status of your generation and retrieve the URL of your generated images. Important note: In case of “FAILED” status, your photos are automatically refunded.

Request Parameters

string

required

The unique user identifier (UUID) that you can retrieve from your Developer Space

string

required

The unique generation identifier (UUID) returned by the generation API

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

Request Example

curl --request POST \
--url 'https://iacrea.com/api/declutter_total/get' \
--header x-api-key:API_KEY \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid"
}'

Response Example

{
  "status": "SUCCEEDED",
  "urls": ["https://generated-image-url"],
  "variationNumber": 2
}

API Documentation

Endpoints

Decluttering API

Decluttering API

Generate a decluttered image

Request Parameters

Response

Request Example

Response Example

Generate a variation of a decluttered image

Request Parameters

Response

Request Example

Response Example

Retrieve a decluttered image

Request Parameters

Response

Request Example

Response Example

​Decluttering API

​Generate a decluttered image

​Request Parameters

​Response

​Request Example

​Response Example

​Generate a variation of a decluttered image

​Request Parameters

​Response

​Request Example

​Response Example

​Retrieve a decluttered image

​Request Parameters

​Response

​Request Example

​Response Example

Decluttering API

Generate a decluttered image

Request Parameters

Response

Request Example

Response Example

Generate a variation of a decluttered image

Request Parameters

Response

Request Example

Response Example

Retrieve a decluttered image

Request Parameters

Response

Request Example

Response Example