API Création d'Extérieur
Documentation de l’API pour le service de création d’extérieurs
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
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
URL de l’image servant de base à la création (format: jpg, png)
URL du masque indiquant la zone où l’extérieur doit être généré
Type d’extérieur à générer. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”
Largeur de l’image en pixels
Hauteur de l’image en pixels
L’URL que nous appelons une fois que la génération est terminée
Réponse
L’identifiant unique de la génération (UUID) à utiliser avec l’API de récupération
Le nombre de photos restant suite à cette génération
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
L’identifiant unique de l’utilisateur (UUID)
L’identifiant unique de la génération précédente
URL de l’image originale utilisée pour la génération précédente
URL optionnelle d’un nouveau masque. Si non fourni, le masque de la génération précédente sera utilisé
Type d’extérieur pour cette variation. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”
L’URL que nous appelons une fois que la génération est terminée
Réponse
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
L’identifiant unique de l’utilisateur (UUID)
L’identifiant unique de la génération à récupérer
Réponse
Le statut de la génération: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
Un tableau d’URL contenant les URLs des images générées (présent seulement si status=“SUCCEEDED”)
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.