> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iacrea.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

**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

```bash theme={null}
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

```json theme={null}
{
  "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

```bash theme={null}
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

```json theme={null}
{
  "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

```bash theme={null}
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

```json theme={null}
{
  "status": "SUCCEEDED",
  "urls": ["https://url-de-image-generée"],
  "variationNumber": 0
}
```

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.