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
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
string
requis
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
string
requis
URL de l’image que vous souhaitez désencombrer (format: jpg, png)
string
Traitement automatique appliqué à l’image entière, sans masque :
empty pour vider la pièce de son mobilier et de sa décoration, tidy pour la ranger en retirant le bazar, les bibelots, petits objets, livres et objets décoratifs. Ne peut pas être combiné avec mask_url.boolean
Alias historique de
mode: "empty". Si défini à true, l’IA détecte et supprime automatiquement les objets sur l’image entière. Sinon, vous devez fournir un masque.string
URL du masque (png) indiquant les zones à désencombrer. Requis lorsque vous ne fournissez ni
mode ni auto: true.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
mode ou auto: true) et le traitement masqué (mask_url) sont exclusifs. La requête est refusée avec un statut 400 si vous fournissez mode et mask_url, ou si vous ne fournissez aucun des trois (mode, auto: true, mask_url).
Réponse
string
L’identifiant unique de la génération (UUID) à utiliser avec l’API de récupération
number
Le nombre de photos restant suite à cette génération
string
L’identifiant unique du projet (UUID)
Exemple de requête
Exemple de réponse
Générer une variation d’une image désencombrée
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. Note importante: une variation rejoue le traitement de la génération parente. Lemode (ou le auto) de la génération d’origine est repris automatiquement ; les champs mode et auto envoyés dans le corps de la requête sont ignorés. Pour obtenir un traitement différent, lancez une nouvelle génération.
Paramètres de la requête
string
requis
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
string
requis
L’identifiant unique de la génération précédente dont vous souhaitez créer une variation
string
requis
URL de l’image originale à désencombrer
string
URL du masque indiquant les zones à désencombrer. Requis uniquement si la génération parente utilisait un masque et que vous souhaitez en changer : sans lui, le masque de la génération parente est réutilisé. Ignoré si la génération parente était automatique (
mode ou auto: true).Réponse
string
L’identifiant unique de la nouvelle génération (UUID) à utiliser avec l’API de récupération
number
Le nombre de photos restant suite à cette génération
Exemple de requête
Exemple de réponse
Récupérer une image désencombrée
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
string
requis
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
string
requis
L’identifiant unique de la génération (UUID) retourné par l’API de génération
Réponse
string
Le status de la génération: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
array
Un tableau d’URL contenant les URLs des images générées (présent seulement si status=“SUCCEEDED”)
number
Le nombre de variations déjà effectuées sur ce projet