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

POST /api/create_exterior/generate

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

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 servant de base à la création (format: jpg, png)

mask_url
string
required

URL du masque indiquant la zone où l’extérieur doit être généré

room_type
string
required

Type d’extérieur à générer. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”

width
number
required

Largeur de l’image en pixels

height
number
required

Hauteur de l’image en pixels

webhook
string

L’URL que nous appelons une fois que la génération est terminée

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/create_exterior/generate' \
--header 'x-api-key: VOTRE_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "image_url": "https://exemple.com/image.jpg",
  "mask_url": "https://exemple.com/masque.png",
  "room_type": "TERRACE",
  "width": 1024,
  "height": 768
}'

Exemple de réponse

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

Générer une variation d’extérieur

POST /api/create_exterior/generate-variation

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

user_id
string
required

L’identifiant unique de l’utilisateur (UUID)

generation_id
string
required

L’identifiant unique de la génération précédente

original_url
string
required

URL de l’image originale utilisée pour la génération précédente

mask_url
string

URL optionnelle d’un nouveau masque. Si non fourni, le masque de la génération précédente sera utilisé

room_type
string
required

Type d’extérieur pour cette variation. Valeurs possibles: “TERRACE”, “POOL”, “PETANQUE”

webhook
string

L’URL que nous appelons une fois que la génération est terminée

Réponse

generation_id
string

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

Exemple de requête

curl --request POST \
--url 'https://iacrea.com/api/create_exterior/generate-variation' \
--header 'x-api-key: VOTRE_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid",
  "original_url": "https://exemple.com/image.jpg",
  "mask_url": "https://exemple.com/nouveau-masque.png",
  "room_type": "POOL"
}'

Exemple de réponse

{
  "generation_id": "uuid"
}

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

POST /api/create_exterior/get

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

user_id
string
required

L’identifiant unique de l’utilisateur (UUID)

generation_id
string
required

L’identifiant unique de la génération à récupérer

Réponse

status
string

Le statut 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/create_exterior/get' \
--header 'x-api-key: VOTRE_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": 0
}

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