AiGenerator

Begin the download process

Changed on Nov 20, 2025

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 one of the valid download sizes retrieved through the "Get Download Sizes" endpoint
notes	This is an optional free text parameter often used by clients who wish to include notes specific to their integration. This is for use by Getty Images customers only (not iStock). The products endpoint (GET /v3/products) provides this information.
project_code	If your Getty Images Generative AI product requires project_codes, use of this parameter is required. If your product does not require a project_code, this parameter must be excluded from the request. This is for use by Getty Images customers only (not iStock). The products endpoint (GET /v3/products) provides this information.
product_id	The product id to download against. Only required when the customer has more than one agreement.

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.

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

Request

Base URL
https://api.gettyimages.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header Api-Key
- or OAuth 2
  Authorization codehttps://authentication.gettyimages.com/oauth2/auth
  Client credentials
  Password
  Token URLhttps://authentication.gettyimages.com/oauth2/token
TypeScript
https://skmtc.dev/gettyimages/apis/getty-images-api/docs/v3/ai/image-generations/:generationRequestId/images/:index/download/put.ts
A function with typed inputs. Its response is checked against the schema.

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

Request body

notesstring nullable

The notes to use for the download request. Some products require this value.

project_codestring nullable

The project code to use for the download request. Some products require this value.

size_namestring nullable

The size name. Valid values are 1k or 4k.

product_idinteger nullable

The product id to download against. Only required when the customer has more than one agreement.

Response

Download request was successful but is pending

Changes

Nov 20, 202581cb0e852242 Revision changes
- breaking
  removed the success response with the status
Mar 7, 2025328d929c7310 Revision changes
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the non-success response with the status

Operation history (4 revisions)