Blue Sky API
API documentation for the blue sky service
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
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
The unique user identifier (UUID) that you can retrieve from your Developer Space
URL of the image whose sky you want to modify (format: jpg, png)
The URL we call once the generation is complete. The request body is the same as the response from the retrieval API
Response
The unique generation identifier (UUID) to use with the retrieval API
The number of photos remaining after this generation
The unique project identifier (UUID)
Request Example
Response Example
Generate a variation of a blue sky
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
The unique user identifier (UUID) that you can retrieve from your Developer Space
The unique identifier of the previous generation you want to create a variation of
Response
The unique identifier of the new generation (UUID) to use with the retrieval API
The number of photos remaining after this generation
Request Example
Response Example
Retrieve a blue sky
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
The unique user identifier (UUID) that you can retrieve from your Developer Space
The unique generation identifier (UUID) returned by the generation API
Response
The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
An array containing the URLs of generated images (present only if status=“SUCCEEDED”)
The number of variations already performed on this project