v1

latestOpenAPI 3.0.42026-07-1376217536.1 KB
AiGenerator

Once the download process has started, this endpoint can be used to check the status of the download and get the download URL once it is completed.

AI Generator - Get Download Image

Get the download for a generated image

Fulfilled and Pending Results

In many cases the result of this call will be the final fulfilled result. In these cases, you will see a HTTP 200 OK result and a payload including a URL for the download.

However some generations may take more time than can be accommodated in the initial call. In these cases the result of this call is HTTP 202 Accepted with no payload. This client should then poll GET v3/ai/image-generations/{generationRequestId}/images/{index}/download periodically to get the final download.

Like the PUT v3/ai/image-generations/{generationRequestId}/images/{index}/download endpoint, the result of calling this endpoint will be either:

  • HTTP 200 OK with the download URL
  • HTTP 202 Accepted with no payload

HTTP 202 Accepted is returned in the case where the download preparation has not yet completed. In this case it is expected that the client will occasionally poll this endpoint until a HTTP 200 OK result with a full payload is returned.

get/v3/ai/image-generations/{generationRequestId}/images/{index}/download

Path parameters

generationRequestIdstring required

The ID from a previous request to generate images

indexinteger required

The index of the image from the specific images generation

Response

Download request was successful and is complete

urlstring nullable
generated_asset_idstring nullable