API Plan 3D
Documentation de l’API pour le service de génération à partir d’un plan 3D
API Plan 3D
Le service de Plan 3D vous permet de générer une visualisation réaliste d’un espace à partir d’un plan 3D. Idéal pour visualiser des projets immobiliers avant leur construction.
Générer une rénovation à partir d’un plan
Ce endpoint permet de générer une représentation visuelle réaliste à partir d’un plan. Comme une génération peut prendre plusieurs minutes pour s’exécuter, le résultat n’est pas immédiatement disponible.
Pour obtenir le résultat final, vous devez soit fournir une URL de webhook, soit interroger régulièrement l’API de récupération.
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 du plan à transformer (format: jpg, png)
Thème de votre nouvelle rénovation. Les valeurs dépendent du type de pièce sélectionné. Exemples: “MODERN”, “SCANDINAVIAN”, “LUXURIOUS”, etc.
Votre type de pièce. Valeurs possibles: LIVING_ROOM, BEDROOM, EMPTY, KITCHEN, DINING_ROOM, DINING_LIVING_ROOM, HOME_OFFICE, SHOWEROOM, BATHROOM, VERANDA, WC
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 à partir d’un plan
Ce endpoint permet de générer une variation à partir d’un résultat précédent de génération de plan. Comme une génération peut prendre plusieurs minutes, le résultat n’est pas immédiatement disponible.
Paramètres de la requête
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
L’identifiant unique de la génération précédente dont vous souhaitez créer une variation
Thème de votre nouvelle rénovation
Votre type de pièce
Réponse
L’identifiant unique de la nouvelle génération (UUID) à utiliser avec l’API de récupération
Le nombre de photos restant suite à cette génération
Exemple de requête
Exemple de réponse
Récupérer une rénovation générée à partir d’un plan
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
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
L’identifiant unique de la génération (UUID) retourné par l’API de génération
Réponse
Le status 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