POST /v3/downloads/images/{id}

Use this endpoint to generate download URLs and related data for images you are authorized to download.

Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.

The download limit for a given download period is covered in your product agreement established with Getty Images.

You'll need an API key and a Resource Owner Grant or Implicit Grant access token to use this resource.

Auto Downloads

The auto_download request query parameter specifies whether to automatically download the image.

If the auto_download request query parameter is set to true, the API will return an HTTP status code 303 See Other. Your client code will need to process this response and redirect to the URI specified in the Location header to enable you to automatically download the file. The redirection workflow follows the HTTP 1.1 protocol.

Client Request:

https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true

Server Response:

Your client code should follow redirect (3xx) status codes returned from the URI in the response Location header. More information here: HTTP 1.1 protocol.

HTTP/1.1 303 See Other
Location: https://delivery.gettyimages.com/...

If the auto_download request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image.

Client Request:

https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false

Server Response:

HTTP/1.1 200 OK
{
	"uri": "https://delivery.gettyimages.com/..."
}

Downloading Via the Returned URI

Your client code should follow redirect (3xx) status codes returned from the URI in the response. More information here: HTTP 1.1 protocol.

The URI returned by this call should be considered opaque and the format could change at any time. In order to get the filename, length or file type, the response headers must be inspected. An example response follows:

content-length: 33959979
content-type: image/jpeg
content-disposition: attachment; filename=GettyImages-1167612765.jpg

The content-disposition header must be parsed to get a usable filename.

Download URI expiration

Download URIs are only valid for 24 hours, starting from the moment they are returned from this call.

Servers

https://api.gettyimages.com

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Id of image to download.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Accept-Language`	String	No	Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).

Query parameters

Name	Type	Required	Description
`auto_download`	Boolean	No	Specifies whether to auto-download the image. If true is specified, a 303 SeeOther status is returned with a Location header set to the location of the image. If false is specified, the download URI will be returned in the response message. Default is true. Default value: true
`height`	String	No	Specifies the pixel height of the particular image to download. Available heights can be found in the images/{ids} response for the specific image. If left blank, it will return the largest available size.
`product_type`	String	No	Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. Default product type for iStock API keys is creditpack. Valid values: `"royaltyfreesubscription"` `"editorialsubscription"` `"creditpack"` `"imagepack"` `"premiumaccess"` `"easyaccess"` `"aigen"`
`file_type`	String	No	File Type expressed with three character file extension. Valid values: `"eps"` `"jpg"`
`product_id`	Integer	No	Identifier of the instance for the selected product offering type.
`use_team_credits`	Boolean	No	Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False. Default value: false

Request body fields

Name	Type	Required	Description
`project_code`	String	No
`download_notes`	String	No

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.