Get metadata for a single image by supplying one image id
Changed onThis endpoint returns the detailed image metadata for a specified image.
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"
]
}
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
- Base URLhttps://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 2Authorization codehttps://authentication.gettyimages.com/oauth2/authClient credentialsPasswordToken URLhttps://authentication.gettyimages.com/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
An image id. For more than one image please use the /v3/images endpoint.
Query parameters
Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates.
Headers
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).
Response
OK
Changes
- breaking
removed the enum value
detail_setfrom the propertyitems/of thequeryrequest parameterfields
- breaking
- info
added the enum value
istock_exclusiveto the propertyitems/of thequeryrequest parameterfields - info
added the optional property
//to the response with the status
- info