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

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 beta/ai/image-generations/{generationRequestId}/images/{index}/download periodically to get the final download.

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

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.

Servers

Path parameters

Name Type Required Description
generationRequestId String Yes

The ID from a previous request to generate images

index Integer Yes

The index of the image from the specific images generation

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.