GET /v3/images
This endpoint returns the detailed image metadata for all specified images.
You'll need an API key and access token to use this resource.
Working with Fields Sets
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
Summary Fields Set
The summary_set query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include summary_set in your request.
{
"images":
[
"artist",
"asset_family",
"caption",
"collection_code",
"collection_id",
"collection_name",
"license_model",
"max_dimensions",
"title"
]
}
Detail Fields Set
The detail_set query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include detail_set in your request.
{
"images":
[
"allowed_use",
"artist",
"artist_title",
"asset_family",
"call_for_image",
"caption",
"city",
"collection_code",
"collection_id",
"collection_name",
"color_type",
"copyright",
"country",
"credit_line",
"date_created",
"date_submitted",
"download_sizes",
"editorial_segments",
"event_ids",
"graphical_style",
"license_model",
"max_dimensions",
"orientation",
"product_types",
"quality_rank",
"referral_destinations",
"state_province",
"title"
]
}
Display Fields Set
The display_set query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include display_set in your request.
The URI provided is subject to change at any time and must be used as-is with no modification.
{
"images":
[
"display_sizes":
[
{
"is_watermarked": <boolean>,
"name": "comp",
"uri": "<link>"
},
{
"is_watermarked": <boolean>,
"name": "preview",
"uri": "<link>"
},
{
"is_watermarked": <boolean>,
"name": "thumb",
"uri": "<link>"
}
]
]
}
Request Usage Considerations
- Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.
Servers
- https://api.gettyimages.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
fields[] |
Array | No |
Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates. |
ids[] |
Array | No |
Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids. Maximum of 100 ids. |
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.