Passer au contenu principal

​
API Désencombrement

Le service de désencombrement vous permet de supprimer automatiquement les objets indésirables de vos photos d’intérieur, créant ainsi des espaces plus propres et plus attrayants pour vos annonces immobilières.

​
Générer une image désencombrée

​
POST /api/declutter_total/generate
Appeler cette endpoint lance une nouvelle génération permettant de désencombrer une image. Cette endpoint créé aussi un nouveau projet, suivant votre abonnement, il est possible sur un même projet d’obtenir des variations gratuites. Comme une génération peut prendre plusieurs minutes, le résultat n’est pas immédiatement disponible. Vous pouvez soit fournir une URL de webhook, soit interroger régulièrement l’API de récupération.

​
Paramètres de la requête

​
user_id
string
required
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
​
image_url
string
required
URL de l’image que vous souhaitez désencombrer (format: jpg, png)
​
auto
boolean
Si défini à true, l’IA détectera automatiquement les objets à supprimer. Sinon, vous devrez fournir un masque.
​
webhook
string
L’URL que nous appelons une fois que la génération est terminée. Le request body est le même que la réponse de l’API de récupération

​
Réponse

​
generation_id
string
L’identifiant unique de la génération (UUID) à utiliser avec l’API de récupération
​
remaining_photos
number
Le nombre de photos restant suite à cette génération
​
project_id
string
L’identifiant unique du projet (UUID)

​
Exemple de requête

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
}'

​
Exemple de réponse

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

​
Générer une variation d’une image désencombrée

​
POST /api/declutter_total/generate-variation
Appeler cette endpoint permet de générer une variation d’une image précédemment désencombrée, en spécifiant éventuellement un nouveau masque. Comme une génération peut prendre plusieurs minutes, le résultat n’est pas immédiatement disponible.

​
Paramètres de la requête

​
user_id
string
required
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
​
generation_id
string
required
L’identifiant unique de la génération précédente dont vous souhaitez créer une variation
​
original_url
string
required
URL de l’image originale à désencombrer
​
mask_url
string
required
URL du masque indiquant les zones à désencombrer

​
Réponse

​
generation_id
string
L’identifiant unique de la nouvelle génération (UUID) à utiliser avec l’API de récupération
​
remaining_photos
number
Le nombre de photos restant suite à cette génération

​
Exemple de requête

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"
}'

​
Exemple de réponse

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

​
Récupérer une image désencombrée

​
POST /api/declutter_total/get
Ce endpoint vous permet d’obtenir le résultat d’une génération précédemment effectuée. Il permet de savoir où en est votre génération grâce au statut et de récupérer l’url de vos images générées. Note importante: En cas de statut “FAILED”, vos photos sont automatiquement remboursées.

​
Paramètres de la requête

​
user_id
string
required
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
​
generation_id
string
required
L’identifiant unique de la génération (UUID) retourné par l’API de génération

​
Réponse

​
status
string
Le status de la génération: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
​
urls
array
Un tableau d’URL contenant les URLs des images générées (présent seulement si status=“SUCCEEDED”)
​
variationNumber
number
Le nombre de variations déjà effectuées sur ce projet

​
Exemple de requête

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"
}'

​
Exemple de réponse

{
  "status": "SUCCEEDED",
  "urls": ["https://url-de-image-generée"],
  "variationNumber": 2
}
⌘I