> ## 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 Ciel Bleu

> Documentation de l'API pour le service d'obtention d'un ciel bleu

# API Ciel Bleu

Le service de ciel bleu vous permet de transformer un ciel nuageux, gris ou peu attrayant en un ciel bleu éclatant, améliorant ainsi considérablement l'apparence de vos photos extérieures.

## Générer un ciel bleu

<ParamField path="POST /api/sky/generate" />

Appeler cette endpoint lance une nouvelle génération permettant d'obtenir un ciel bleu. Cette endpoint créé aussi un nouveau projet, suivant votre abonnement, il est possible sur un même projet d'obtenir des variations gratuites.

Comme une génération peut prendre plusieurs minutes, le résultat n'est pas immédiatement disponible. Vous pouvez soit fournir une URL de webhook, soit interroger régulièrement l'API de récupération.

### Paramètres de la requête

<ParamField body="user_id" type="string" required>
  L'identifiant unique de l'utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
</ParamField>

<ParamField body="image_url" type="string" required>
  URL de l'image dont vous voulez modifier le ciel (format: jpg, png)
</ParamField>

<ParamField body="webhook" type="string">
  L'URL que nous appelons une fois que la génération est terminée. Le request body est le même que la réponse de l'API de récupération
</ParamField>

### Réponse

<ResponseField name="generation_id" type="string">
  L'identifiant unique de la génération (UUID) à utiliser avec l'API de récupération
</ResponseField>

<ResponseField name="remaining_photos" type="number">
  Le nombre de photos restant suite à cette génération
</ResponseField>

<ResponseField name="project_id" type="string">
  L'identifiant unique du projet (UUID)
</ResponseField>

### Exemple de requête

```bash theme={null}
curl --request POST \
--url 'https://iacrea.com/api/sky/generate' \
--header x-api-key:API_KEY \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "image_url": "https://my-image-url.jpg"
}'
```

### Exemple de réponse

```json theme={null}
{
  "generation_id": "uuid",
  "remaining_photos": 100,
  "project_id": "uuid"
}
```

## Générer une variation d'un ciel bleu

<ParamField path="POST /api/sky/generate-variation" />

Appeler cette endpoint permet de générer une variation d'un ciel bleu précedemment généré. Comme une génération peut prendre plusieurs minutes, le résultat n'est pas immédiatement disponible.

### Paramètres de la requête

<ParamField body="user_id" type="string" required>
  L'identifiant unique de l'utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
</ParamField>

<ParamField body="generation_id" type="string" required>
  L'identifiant unique de la génération précédente dont vous souhaitez créer une variation
</ParamField>

### Réponse

<ResponseField name="generation_id" type="string">
  L'identifiant unique de la nouvelle génération (UUID) à utiliser avec l'API de récupération
</ResponseField>

<ResponseField name="remaining_photos" type="number">
  Le nombre de photos restant suite à cette génération
</ResponseField>

### Exemple de requête

```bash theme={null}
curl --request POST \
--url 'https://iacrea.com/api/sky/generate-variation' \
--header x-api-key:API_KEY \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid"
}'
```

### Exemple de réponse

```json theme={null}
{
  "generation_id": "uuid",
  "remaining_photos": 100
}
```

## Récupérer un ciel bleu

<ParamField path="POST /api/sky/get" />

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

<ParamField body="user_id" type="string" required>
  L'identifiant unique de l'utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur
</ParamField>

<ParamField body="generation_id" type="string" required>
  L'identifiant unique de la génération (UUID) retourné par l'API de génération
</ParamField>

### Réponse

<ResponseField name="status" type="string">
  Le status de la génération: "STARTING", "PROCESSING", "SUCCEEDED", "FAILED"
</ResponseField>

<ResponseField name="urls" type="array">
  Un tableau d'URL contenant les URLs des images générées (présent seulement si status="SUCCEEDED")
</ResponseField>

<ResponseField name="variationNumber" type="number">
  Le nombre de variations déjà effectuées sur ce projet
</ResponseField>

### Exemple de requête

```bash theme={null}
curl --request POST \
--url 'https://iacrea.com/api/sky/get' \
--header x-api-key: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": 2
}
```