PUT /v3/ai/image-generations/{generationRequestId}/images/{index}/download
AI Generator - Download Image
Download a generated image. Initiating the download process for a 4K file may incur a cost depending on the terms of your agreement.
Download Image Request body details
The ImageDownloadRequest payload to be posted contains the required size as well as some other optional
parameters:
| Parameter | Purpose |
|---|---|
size_name Required | Must be either 4k or 1k |
notes | A note for the download. Some products require a note. |
project_code | The project code for the download. Some products require a project code. |
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.
Servers
- https://api.gettyimages.com
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 |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_code |
String | No |
The project code to use for the download request. Some products require this value. |
notes |
String | No |
The notes to use for the download request. Some products require this value. |
size_name |
String | No |
The size name. Valid values are 1k or 4k. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.