Skip to main content

​
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

​
POST /api/declutter_total/generate
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

​
user_id
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
​
image_url
string
required
URL of the image you want to declutter (format: jpg, png)
​
auto
boolean
If set to true, the AI will automatically detect objects to remove. Otherwise, you will need to provide a mask.
​
webhook
string
The URL we call once the generation is complete. The request body is the same as the response from the retrieval API

​
Response

​
generation_id
string
The unique generation identifier (UUID) to use with the retrieval API
​
remaining_photos
number
The number of photos remaining after this generation
​
project_id
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",
  "auto": true
}'

​
Response Example

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

​
Generate a variation of a decluttered image

​
POST /api/declutter_total/generate-variation
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.

​
Request Parameters

​
user_id
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
​
generation_id
string
required
The unique identifier of the previous generation you want to create a variation of
​
original_url
string
required
URL of the original image to declutter
​
mask_url
string
required
URL of the mask indicating areas to declutter

​
Response

​
generation_id
string
The unique identifier of the new generation (UUID) to use with the retrieval API
​
remaining_photos
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",
  "mask_url": "https://my-mask-url.png"
}'

​
Response Example

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

​
Retrieve a decluttered image

​
POST /api/declutter_total/get
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

​
user_id
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
​
generation_id
string
required
The unique generation identifier (UUID) returned by the generation API

​
Response

​
status
string
The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
​
urls
array
An array containing the URLs of generated images (present only if status=“SUCCEEDED”)
​
variationNumber
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
}
⌘I