Blue Sky API

The blue sky service allows you to transform a cloudy, gray, or unattractive sky into a bright blue sky, significantly enhancing the appearance of your outdoor photos.

Generate a blue sky

POST /api/sky/generate

Calling this endpoint launches a new generation to obtain a blue sky. This endpoint also creates a new project; depending on your subscription, it is possible to obtain free variations on the same project.

As generation can take several minutes, the result is not immediately available. You can either provide a webhook URL or regularly query the retrieval API.

Request Parameters

user_id
string
required

The unique user identifier (UUID) that you can retrieve from your Developer Space

image_url
string
required

URL of the image whose sky you want to modify (format: jpg, png)

webhook
string

The URL we call once the generation is complete. The request body is the same as the response from the retrieval API

Response

generation_id
string

The unique generation identifier (UUID) to use with the retrieval API

remaining_photos
number

The number of photos remaining after this generation

project_id
string

The unique project identifier (UUID)

Request Example

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"
}'

Response Example

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

Generate a variation of a blue sky

POST /api/sky/generate-variation

Calling this endpoint allows you to generate a variation of a previously generated blue sky. As generation can take several minutes, the result is not immediately available.

Request Parameters

user_id
string
required

The unique user identifier (UUID) that you can retrieve from your Developer Space

generation_id
string
required

The unique identifier of the previous generation you want to create a variation of

Response

generation_id
string

The unique identifier of the new generation (UUID) to use with the retrieval API

remaining_photos
number

The number of photos remaining after this generation

Request Example

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"
}'

Response Example

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

Retrieve a blue sky

POST /api/sky/get

This endpoint allows you to obtain the result of a previously performed generation. It lets you know the status of your generation and retrieve the URL of your generated images.

Important note: In case of “FAILED” status, your photos are automatically refunded.

Request Parameters

user_id
string
required

The unique user identifier (UUID) that you can retrieve from your Developer Space

generation_id
string
required

The unique generation identifier (UUID) returned by the generation API

Response

status
string

The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”

urls
array

An array containing the URLs of generated images (present only if status=“SUCCEEDED”)

variationNumber
number

The number of variations already performed on this project

Request Example

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"
}'

Response Example

{
  "status": "SUCCEEDED",
  "urls": ["https://generated-image-url"],
  "variationNumber": 2
}