Skip to main content

API Création d’Extérieur

Le service de Création d’Extérieur vous permet de générer des visualisations réalistes d’espaces extérieurs à partir d’une zone désignée dans une image.

Générer une création d’extérieur

Cet endpoint lance une nouvelle génération pour créer un espace extérieur dans une zone spécifiée par un masque. Cette opération crée aussi un nouveau projet.

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 servant de base à la création (format: jpg, png)
string
requis
URL du masque indiquant la zone où l’extérieur doit être généré
string
requis
Type d’extérieur à générer. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”
number
requis
Largeur de l’image en pixels
number
requis
Hauteur de l’image en pixels
string
L’URL que nous appelons une fois que la génération est terminée

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’extérieur

Cet endpoint permet de générer une variation d’une création d’extérieur précédemment réalisée.

Paramètres de la requête

string
requis
L’identifiant unique de l’utilisateur (UUID)
string
requis
L’identifiant unique de la génération précédente
string
requis
URL de l’image originale utilisée pour la génération précédente
string
URL optionnelle d’un nouveau masque. Si non fourni, le masque de la génération précédente sera utilisé
string
requis
Type d’extérieur pour cette variation. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”
string
L’URL que nous appelons une fois que la génération est terminée

Réponse

string
L’identifiant unique de la nouvelle génération

Exemple de requête

Exemple de réponse

Récupérer une création d’extérieur

Cet endpoint vous permet d’obtenir le résultat d’une génération précédemment effectuée.

Paramètres de la requête

string
requis
L’identifiant unique de l’utilisateur (UUID)
string
requis
L’identifiant unique de la génération à récupérer

Réponse

string
Le statut 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

Exemple de requête

Exemple de réponse

Note importante: En cas de statut “FAILED”, vos photos sont automatiquement remboursées.