Build applications using the world's most powerful imagery
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default page_size is 10, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default page is 1. |
fields
|
array |
Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned. |
artist_name
|
string |
Name of artist for desired images |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsArtistsImageSearchResults
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsArtistsImageSearchItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default page_size is 10, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default page is 1. |
fields
|
array |
Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned. |
artist_name
|
string |
Name of artist for desired images |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsArtistsVideoSearchResults
|
object |
videos
|
array [GettyImagesModelsArtistsVideoSearchItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_count
|
integer |
Confirm asset changes acknowledges receipt of asset changes (from the PUT asset changes endpoint).
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
change-set-id
|
long |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Get notifications about new, updated or deleted assets.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Partner channels that have not been checked within the last 120 days will be removed and that partner will no longer be able to get change notifications from that channel. Partners who would like to start using the Asset Changes API again after a period of dormancy should contact their sales representative to be set up again.
Name | Data Type | Description |
---|---|---|
batch_size
|
integer |
Specifies the number of assets to return. The default is 10; maximum is 500. |
channel_id
|
integer |
Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
AssetChanges
|
object |
changed_assets
|
array [ChangedAssetDetail] |
Contains a list of ChangedAssetList results for the query. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
change_set_id
|
string |
Contains the identifier for the change-set resource. Passed into ConfirmAssetChanges requests to confirm receipt of the asset changes in the response. |
Retrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Only channels that have been queried in the last 120 days will be included in the list of channels. Partners who have a channel that has been removed should contact their sales representative to be set up again.
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
PartnerChannelList
|
object |
channels
|
array [PartnerChannel] | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
assetId
|
string |
Getty Images assetId - examples 520621493, 112301284 |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesControllersAssetLicensingAcquireAssetLicensesRequest
|
object |
UseTeamCredits
|
boolean |
Defaults to false. |
LicenseTypes
|
array [string] Allowed values: - Multiseat - Unlimited - Resale - Indemnification |
Name | Data Type | Description |
---|---|---|
GettyImagesControllersAssetLicensingAssetLicensingResponse
|
object |
CreditsUsed
|
integer | |
AcquiredLicenses
|
array [string] Allowed values: - Standard - Multiseat - Unlimited - Resale - Indemnification |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to remove an asset from a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string | |
asset_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to add an asset to a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string | |
asset_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
Object
|
object |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to remove a set of assets from a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
asset_ids
|
array |
List the assets to be removed from the board. |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to add a set of assets to a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
board_assets
|
array [BoardAsset] | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
AddBoardAssetsResult
|
object |
assets_not_added
|
array [string] | ||||||||
assets_added
|
array [BoardAsset] | ||||||||
Properties
|
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to delete a comment from a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
comment_id
|
string | |
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
Object
|
object |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to retrieve all comments for a specific board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
CommentsList
|
object |
permissions
|
BoardCommentPermissions | |||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
comments
|
array [Comment] | |||||||||||||||||||||||||||||||||||||||||||
Properties
|
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to add a comment to a board.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
CommentRequest
|
object |
text
|
string |
Name | Data Type | Description |
---|---|---|
CommentCreated
|
object |
id
|
string |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to delete a Board by a specific id.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to retrieve a Board by a specific id.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
BoardDetail
|
object |
permissions
|
BoardPermissions | ||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||
links
|
Links | ||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||||||
date_last_updated
|
dateTime | ||||||||||||||||||||||||||||||
date_created
|
dateTime | ||||||||||||||||||||||||||||||
comment_count
|
integer | ||||||||||||||||||||||||||||||
assets
|
array [Asset] | ||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
asset_count
|
integer |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to update a Board by a specific id.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
NOTE: The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.
Name | Data Type | Description |
---|---|---|
board_id
|
string |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
BoardInfo
|
object |
name
|
string | |
description
|
string |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to retrieve all Boards available for a user.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
sort_order
|
string Allowed values: - date_last_updated_descending - date_last_updated_ascending - name_ascending - name_decending |
Sort the list of boards by last update date or name. Defaults to date_last_updated_descending. |
pageSize
|
integer |
Request number of boards to return in each page. (default is 30). |
page
|
integer |
Request results starting at a page number (default is 1). |
board_relationship
|
string Allowed values: - owned - invited |
Search for boards the user owns or has been invited to as an editor. |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
BoardList
|
object |
boards
|
array [BoardListBoard] | ||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
board_count
|
integer |
Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to create a Board by a specific id.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
NOTE: The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
BoardInfo
|
object |
name
|
string | |
description
|
string |
Name | Data Type | Description |
---|---|---|
BoardCreated
|
object |
id
|
string |
Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our Image collections page.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsCollectionsCollectionsList
|
object |
collections
|
array [GettyImagesModelsCollectionsCollection] | |||||||||||||||||||||||
Properties
|
Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsCountriesCountriesList
|
object |
countries
|
array [GettyImagesModelsCountriesCountry] | ||||||||||||||
Properties
|
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. Please see our Getting Started page for more information on how to sign up for an API key.
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:
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/..."
}
Name | Data Type | Description |
---|---|---|
id
|
string |
|
Name | Data Type | Description |
---|---|---|
use_team_credits
|
boolean |
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. |
product_type
|
string Allowed values: - easyaccess - editorialsubscription - imagepack - premiumaccess - royaltyfreesubscription |
|
product_id
|
integer |
|
height
|
string |
|
file_type
|
string Allowed values: - eps - jpg |
|
auto_download
|
boolean |
|
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsDownloadsPremiumAccessDownloadData
|
object |
project_code
|
string | |
download_notes
|
string |
Name | Data Type | Description |
---|---|---|
SystemObject
|
object |
Use this endpoint to generate download URLs and related data for videos 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. Please see our Getting Started page for more information on how to sign up for an API key.
The auto_download
request query parameter specifies whether to automatically download the video.
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/videos/[asset_id]?auto_download=true
Server Response:
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 video.
Client Request:
https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false
Server Response:
HTTP/1.1 200 OK
{
"uri": "https://delivery.gettyimages.com/..."
}
Name | Data Type | Description |
---|---|---|
id
|
string |
|
Name | Data Type | Description |
---|---|---|
use_team_credits
|
boolean |
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. |
size
|
string |
Specifies the size to be downloaded. |
product_id
|
integer |
|
auto_download
|
boolean |
|
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsDownloadsPremiumAccessDownloadData
|
object |
project_code
|
string | |
download_notes
|
string |
Name | Data Type | Description |
---|---|---|
SystemObject
|
object |
Returns information about a customer's previously downloaded assets.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
This endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens.
Name | Data Type | Description |
---|---|---|
product_type
|
string Allowed values: - easyaccess - editorialsubscription - imagepack - premiumaccess - royaltyfreesubscription |
Specifies product type to be included in the previous download results. To get previous iStockPhoto credit downloads, credit_pack must be selected. |
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
date_to
|
dateTime |
If specified, select assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). Any hour, minute, second values in the request are not used at this time. Date/times in the response are UTC. Default is current date. |
date_from
|
dateTime |
If specified, select assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). Any hour, minute, second values in the request are not used at this time. Date/times in the response are UTC. Default is 30 days prior to date_to. |
company_downloads
|
boolean |
If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false. |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsDownloadsGetDownloadsResponse
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
downloads
|
array [GettyImagesModelsDownloadsGetDownloadsResponseDownload] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment
photographers and videographers cover editorially relevant events occurring around the world.
All images or video clips produced in association with an event, are assigned the same EventID.
EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images
brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be
consistently assigned an EventID. The Event framework may also be used to group similar content, such as
"Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
id
|
integer |
An event id. |
Name | Data Type | Description |
---|---|---|
fields
|
array |
A comma separated list of fields to return in the response. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsEventsEvent
|
object |
start_date
|
dateTime | |||||||||||||||||||||||||||
name
|
string | |||||||||||||||||||||||||||
location
|
GettyImagesModelsLocationEvent | |||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
image_count
|
integer | |||||||||||||||||||||||||||
id
|
integer | |||||||||||||||||||||||||||
hero_image
|
GettyImagesModelsHeroImage | |||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
editorial_segments
|
array [string] | |||||||||||||||||||||||||||
child_event_count
|
integer |
This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
ids
|
array |
A comma separated list of event ids. |
fields
|
array |
A comma separated list of fields to return in the response. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsEventsEventsResult
|
object |
events_not_found
|
array [integer] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
events
|
array [GettyImagesModelsEventsEvent] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint will search our asset database for images similar to the specified asset id. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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":
[
"asset_family",
"caption",
"collection_code",
"collection_id",
"collection_name",
"display_sizes":
[
{
"name": "thumb"
}
]
"license_model",
"max_dimensions",
"title"
]
}
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",
"asset_family",
"call_for_image",
"caption",
"collection_code",
"collection_id",
"collection_name",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"editorial_segments",
"event_ids",
"graphical_style",
"license_model",
"max_dimensions",
"orientation",
"product_types",
"quality_rank",
"referral_destinations",
"title"
]
}
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
id
|
string |
Identifies an existing image |
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchSearchResultsGettyImagesModelsSearchImageSearchItem
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsSearchImageSearchItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns the detailed image metadata for a specified image. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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"
]
}
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"
]
}
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
id
|
string |
An image id. For more than one image please use the /v3/images endpoint. |
Name | Data Type | Description |
---|---|---|
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field are estimates. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsImagesImagesDetail
|
object |
images_not_found
|
array [string] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsImagesImageDetail] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns the detailed image metadata for all specified images. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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"
]
}
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"
]
}
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field are estimates. |
ids
|
array |
Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsImagesImagesDetail
|
object |
images_not_found
|
array [string] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsImagesImageDetail] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns detailed order metadata for a specified order. Use of this endpoint requires configuration changes to your API key. Please contact developersupport@gettyimages.com to learn more.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
id
|
integer |
An order id. |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsOrdersOrderDetail
|
object |
order_date
|
dateTime | |||||||||||||||||
notes
|
GettyImagesModelsOrdersOrderNotes | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string | |||||||||||||||||
end_client
|
string | |||||||||||||||||
assets
|
array [GettyImagesModelsOrdersAssetIdFromOrder] | |||||||||||||||||
Properties
|
This endpoint returns all products available to the username used during authentication. As such, this endpoint requires the use of a fully authorized access_token. The product data can then be used as search filters, restricting results to images from a specific product.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
fields
|
array |
Comma separated list of fields. Allows product download requirements to be returned. |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsProductsProductsResult
|
object |
products
|
array [GettyImagesModelsProductsProduct] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns a list of all assets purchased on gettyimages.com by the username used for authentication. Use of this endpoint requires configuration changes to your API key. Please contact developersupport@gettyimages.com to learn more.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default is 75, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
date_to
|
dateTime |
If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). |
date_from
|
dateTime |
If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsPurchasesPreviousAssetPurchases
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||
previous_purchases
|
array [GettyImagesModelsPurchasesPreviousAssetPurchase] | ||||||||||||||||||||||||||||||||
Properties
|
This endpoint returns a list of all images purchased on gettyimages.com by the username used for authentication. Use of this endpoint requires configuration changes to your API key. Please contact developersupport@gettyimages.com to learn more.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default is 75, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
date_to
|
dateTime |
If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). |
date_from
|
dateTime |
If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsPurchasesPreviousPurchases
|
object |
result_count
|
integer | ||||||||||||||||||||
previous_purchases
|
array [GettyImagesModelsPurchasesPreviousPurchase] | ||||||||||||||||||||
Properties
|
Use this endpoint to search Getty Images news, sports and entertainment events. Getty Images photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in Search Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token.
Name | Data Type | Description |
---|---|---|
phrase
|
string |
Filters to events related to this phrase |
page_size
|
integer |
Request number of images to return in each page. |
page
|
integer |
Request results starting at a page number (default is 1, maximum is 50). |
fields
|
array |
Specifies fields to return. Default set is 'id','name','start_date'. |
editorial_segment
|
string Allowed values: - archival - entertainment - news - publicity - royalty - sport |
Filters to events with a matching editorial segment. |
date_to
|
dateTime |
Filters to events that start on or before this date. Use ISO 8601 format (e.g., 1999-12-31). |
date_from
|
dateTime |
Filters to events that start on or after this date. Use ISO 8601 format (e.g., 1999-12-31). |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchEventsSearchResult
|
object |
result_count
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
events
|
array [GettyImagesModelsEventsEvent] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Allows searching for similar creative images by passing the URL to an existing image.
Before calling the search by image endpoint, an image must be uploaded to a specific AWS S3 bucket. The bucket name is search-by-image.s3.amazonaws.com
.
For example, using cURL:
curl -i -X PUT https://search-by-image.s3.amazonaws.com/my-test-image.jpg -H "Content-Type: image/jpeg" --data-binary "@testimage.jpg"
Uploads can be overwritten if the names are the same, so using a prefix like the API Key, application name or company name would help keep that from happening.
Once the image has been uploaded, use the full URL in the image_url
parameter, e.g. image_url=https://search-by-image.s3.amazonaws.com/my-test-image.jpg
.
Subsequent searches for the same image can be executed using the image_fingerprint
that is returned by the inital search.
Name | Data Type | Description |
---|---|---|
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
page_size
|
integer |
Request number of images to return in each page. |
page
|
integer |
Request results starting at a page number (default is 1). |
include_facets
|
boolean |
Specifies whether or not to include facets in the result set. Default is "false". |
image_url
|
string |
Specifies the location of the image to use in the search. |
image_fingerprint
|
string |
Specifies the fingerprint of the image to use in the search. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
facet_max_count
|
integer |
Specifies the maximum number of facets to return per type. Default is 300. |
facet_fields
|
array |
Specifies the facets to return in the response. Facets provide additional search parameters to refine your results. The include_facets parameter must be set to "true" for facets to be returned. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
SystemObject
|
object |
Use this endpoint to search our contemporary stock photos, illustrations and archival images.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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":
[
"asset_family",
"caption",
"collection_code",
"collection_id",
"collection_name",
"display_sizes":
[
{
"name": "thumb"
}
],
"license_model",
"max_dimensions",
"title"
]
}
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",
"asset_family",
"call_for_image",
"caption",
"collection_code",
"collection_id",
"collection_name",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"editorial_segments",
"event_ids",
"graphical_style",
"license_model",
"max_dimensions",
"orientation",
"product_types",
"quality_rank",
"referral_destinations",
"title"
]
]
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
sort_order
|
string Allowed values: - best_match - most_popular - newest - random |
Select sort order of results. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Search images using a search phrase. |
page_size
|
integer |
Request number of images to return in each page. |
page
|
integer |
Request results starting at a page number (default is 1). |
orientations
|
array |
Return only images with selected aspect ratios. |
number_of_people
|
array |
Filter based on the number of people in the image. |
minimum_size
|
string Allowed values: - x_small - small - medium - large - x_large - xx_large - vector |
Filter based on minimum size requested. |
license_models
|
array |
Specifies the image licensing model(s). |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
include_facets
|
boolean |
Specifies whether or not to include facets in the result set. Default is "false". |
graphical_styles_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified graphical style(s). |
graphical_styles
|
array |
Filter based on graphical style of the image. |
file_types
|
array |
Return only images having a specific file type. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
facet_max_count
|
integer |
Specifies the maximum number of facets to return per type. Default is 300. |
facet_fields
|
array |
Specifies the facets to return in the response. Facets provide additional search parameters to refine your results. The include_facets parameter must be set to "true" for facets to be returned. |
exclude_nudity
|
boolean |
Excludes images containing nudity. The default is false. |
exclude_editorial_use_only
|
boolean |
Exclude images that are only available for editorial (non-commercial) use. Default value is false. |
ethnicity
|
array |
Filter search results based on the ethnicity of individuals in an image. |
embed_content_only
|
boolean |
Restrict search results to embeddable images. The default is false. |
compositions
|
array |
Filter based on image composition. |
color
|
string |
Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). |
collections_filter_type
|
string Allowed values: - include - exclude |
Use to include or exclude collections from search. |
collection_codes
|
array |
Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type. |
artists
|
string |
Search for images by specific artists (free-text, comma-separated list of artists). |
age_of_people
|
array |
Filter based on the age of individuals in an image. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchCreativeImageSearchResults
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsSearchImageSearchItemCreative] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to search our editorial stock photos, illustrations and archival images. Editorial images represent newsworthy events or illustrate matters of general interest, such as news, sport and entertainment and are generally intended for editorial use.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token. To include your API token in the search request, add it to the headers as a Bearer token (example in curl):
-H "Authorization: Bearer <your-token>"
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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":
[
"asset_family",
"caption",
"collection_code",
"collection_id",
"collection_name",
"display_sizes":
[
{
"name": "thumb"
}
],
"license_model",
"max_dimensions",
"title"
]
}
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",
"asset_family",
"call_for_image",
"caption",
"collection_code",
"collection_id",
"collection_name",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"editorial_segments",
"event_ids",
"graphical_style",
"license_model",
"max_dimensions",
"orientation",
"product_types",
"quality_rank",
"referral_destinations",
"title"
]
]
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
specific_people
|
array |
Return only images associated with specific people (using a comma-delimited list). |
sort_order
|
string Allowed values: - best_match - most_popular - newest - oldest - random |
Select sort order of results. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Search images using a search phrase. |
page_size
|
integer |
Request number of images to return in each page. |
page
|
integer |
Request results starting at a page number (default is 1). |
orientations
|
array |
Return only images with selected aspect ratios. |
number_of_people
|
array |
Filter based on the number of people in the image. |
minimum_size
|
string Allowed values: - x_small - small - medium - large - x_large - xx_large - vector |
Filter based on minimum size requested. |
minimum_quality_rank
|
integer |
Filter search results based on minimum quality ranking. Possible values 1, 2, 3 with 1 being best. |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
include_facets
|
boolean |
Specifies whether or not to include facets in the result set. Default is "false". |
graphical_styles_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified graphical style(s). |
graphical_styles
|
array |
Filter based on graphical style of the image. |
file_types
|
array |
Return only images having a specific file type. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
facet_max_count
|
integer |
Specifies the maximum number of facets to return per type. Default is 300. |
facet_fields
|
array |
Specifies the facets to return in the response. Facets provide additional search parameters to refine your results. The include_facets parameter must be set to "true" for facets to be returned. |
event_ids
|
array |
Filter based on specific events |
ethnicity
|
array |
Filter search results based on the ethnicity of individuals in an image. |
entity_uris
|
array |
specify linked data entity uri. |
embed_content_only
|
boolean |
Restrict search results to embeddable images. The default is false. |
editorial_segments
|
array |
Return only events with a matching editorial segment. |
date_to
|
dateTime |
Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31). |
date_from
|
dateTime |
Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31). |
compositions
|
array |
Filter based on image composition. |
collections_filter_type
|
string Allowed values: - include - exclude |
Use to include or exclude collections from search. |
collection_codes
|
array |
Filter by collections (comma-separated list of collection codes). Include or exclude based on collections_filter_type. |
artists
|
string |
Search for images by specific artists (free-text, comma-separated list of artists). |
age_of_people
|
array |
Filter based on the age of individuals in an image. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchEditorialImageSearchResults
|
object |
result_count
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsSearchImageSearchItemEditorial] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to search over a blend of our contemporary stock photos, illustrations, archival images, editorial photos, illustrations and archival images.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token. To include your API token in the search request, add it to the headers as a Bearer token (example in curl):
-H "Authorization: Bearer <your-token>"
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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":
[
"asset_family",
"caption",
"collection_code",
"collection_id",
"collection_name",
"display_sizes":
[
{
"name": "thumb"
}
],
"license_model",
"max_dimensions",
"title"
]
}
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",
"asset_family",
"call_for_image",
"caption",
"collection_code",
"collection_id",
"collection_name",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"editorial_segments",
"event_ids",
"graphical_style",
"license_model",
"max_dimensions",
"orientation",
"product_types",
"quality_rank",
"referral_destinations",
"title"
]
]
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.
{
"images":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
specific_people
|
array |
Return only images associated with specific people (using a comma-delimited list). |
sort_order
|
string Allowed values: - best_match - most_popular - newest - random |
Select sort order of results. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Search images using a search phrase. |
page_size
|
integer |
Request number of images to return in each page. |
page
|
integer |
Request results starting at a page number (default is 1). |
orientations
|
array |
Return only images with selected aspect ratios. |
number_of_people
|
array |
Filter based on the number of people in the image. |
minimum_size
|
string Allowed values: - x_small - small - medium - large - x_large - xx_large - vector |
Filter based on minimum size requested. |
license_models
|
array |
Specifies the image licensing model(s). |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
graphical_styles_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified graphical style(s). |
graphical_styles
|
array |
Filter based on graphical style of the image. |
file_types
|
array |
Return only images having a specific file type. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
exclude_nudity
|
boolean |
Excludes images containing nudity. The default is false. |
event_ids
|
array |
Filter based on specific events |
ethnicity
|
array |
Filter search results based on the ethnicity of individuals in an image. |
embed_content_only
|
boolean |
Restrict search results to embeddable images. The default is false. |
compositions
|
array |
Filter based on image composition. |
color
|
string |
Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). Note: when specified, results will not contain editorial images. |
collections_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified collection(s). |
collection_codes
|
array |
Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type. |
artists
|
string |
Search for images by specific artists (free-text, comma-separated list of artists). |
age_of_people
|
array |
Filter based on the age of individuals in an image. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchSearchResultsGettyImagesModelsSearchImageSearchItem
|
object |
result_count
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [GettyImagesModelsSearchImageSearchItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to search premium stock video, from archival film to contemporary 4K and HD footage.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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 video in your result set when you include summary_set in your request.
{
"videos":
[
"asset_family",
"caption",
"collection_code",
"collection_name",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"license_model",
"title"
]
}
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 videos. The following fields are provided for every video in your result set when you include detail_set in your request.
{
"videos":
[
"allowed_use",
"artist",
"asset_family",
"call_for_image",
"caption",
"clip_length",
"collection_code",
"collection_id",
"collection_name",
"color_type",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"era",
"license_model",
"mastered_to",
"originally_shot_on",
"product_types",
"shot_speed",
"source",
"title"
]
}
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 video in your result set when you include display_set in your request.
{
"videos":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
sort_order
|
string Allowed values: - best_match - most_popular - newest - random |
Allows sorting of results. |
release_status
|
string Allowed values: - release_not_important - fully_released |
Allows filtering by type of model release. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Free-text search query. |
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
license_models
|
array |
Specifies the video licensing model(s). |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
include_facets
|
boolean |
Specifies whether or not to include facets in the result set. Default is "false". |
frame_rates
|
array |
Provides filtering by video frame rate (frames/second). |
format_available
|
string Allowed values: - sd - hd - 4k |
Filters according to the digital video format available on a film asset. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
facet_max_count
|
integer |
Specifies the maximum number of facets to return per type. Default is 300. |
facet_fields
|
array |
Specifies the facets to return in the response. Facets provide additional search parameters to refine your results. The include_facets parameter must be set to "true" for facets to be returned. |
collections_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified collection(s). |
collection_codes
|
array |
Provides filtering by collection code. |
age_of_people
|
array |
Provides filtering according to the age of individuals in a video. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchCreativeVideoSearchResults
|
object |
videos
|
array [GettyImagesModelsSearchVideoSearchItem] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_count
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facets
|
EnterpriseProxiesPublicV3ControllersSearchFacetsSearchFacetsResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to search current and archival video clips of celebrities, newsmakers, and events.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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 video in your result set when you include summary_set in your request.
{
"videos":
[
"asset_family",
"caption",
"collection_code",
"collection_name",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"license_model",
"title"
]
}
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 videos. The following fields are provided for every video in your result set when you include detail_set in your request.
{
"videos":
[
"allowed_use",
"artist",
"asset_family",
"call_for_image",
"caption",
"clip_length",
"collection_code",
"collection_id",
"collection_name",
"color_type",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"era",
"license_model",
"mastered_to",
"originally_shot_on",
"product_types",
"shot_speed",
"source",
"title"
]
}
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 video in your result set when you include display_set in your request.
{
"videos":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
specific_people
|
array |
Allows filtering by specific peoples' names. |
sort_order
|
string Allowed values: - best_match - most_popular - newest - oldest - random |
Allows sorting of results. |
release_status
|
string Allowed values: - release_not_important - fully_released |
Allows filtering by type of model release. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Free-text search query. |
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
include_facets
|
boolean |
Specifies whether or not to include facets in the result set. Default is "false". |
frame_rates
|
array |
Provides filtering by video frame rate (frames/second). |
format_available
|
string Allowed values: - sd - hd - 4k |
Filters according to the digital video format available on a film asset. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
facet_max_count
|
integer |
Specifies the maximum number of facets to return per type. Default is 300. |
facet_fields
|
array |
Specifies the facets to return in the response. Facets provide additional search parameters to refine your results. The include_facets parameter must be set to "true" for facets to be returned. |
entity_uris
|
array |
specify link data entity uri. |
editorial_video_types
|
array |
Allows filtering by types of video. |
collections_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified collection(s). |
collection_codes
|
array |
Provides filtering by collection code. |
age_of_people
|
array |
Provides filtering according to the age of individuals in a video. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchEditorialVideoSearchResults
|
object |
videos
|
array [GettyImagesModelsSearchVideoSearchItem] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_count
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facets
|
EnterpriseProxiesPublicV3ControllersSearchFacetsSearchFacetsResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to search over a blend of our premium stock, contemporary 4K and HD footage, celebrities, news, newsmakers, entertainment, events and archival videos.
You'll need an API key and access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token.
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
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 video in your result set when you include summary_set in your request.
{
"videos":
[
"asset_family",
"caption",
"collection_code",
"collection_name",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"license_model",
"title"
]
}
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 videos. The following fields are provided for every video in your result set when you include detail_set in your request.
{
"videos":
[
"allowed_use",
"artist",
"asset_family",
"call_for_image",
"caption",
"clip_length",
"collection_code",
"collection_id",
"collection_name",
"color_type",
"copyright",
"date_created",
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
],
"era",
"license_model",
"mastered_to",
"originally_shot_on",
"product_types",
"shot_speed",
"source",
"title"
]
}
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 video in your result set when you include display_set in your request.
{
"videos":
[
"display_sizes":
[
{
"name": "comp"
},
{
"name": "preview"
},
{
"name": "thumb"
}
]
]
}
Name | Data Type | Description |
---|---|---|
specific_people
|
array |
Provides filtering by specific peoples' names. |
sort_order
|
string Allowed values: - best_match - most_popular - newest - oldest - random |
Allows sorting of results. |
release_status
|
string Allowed values: - release_not_important - fully_released |
Allows filtering by type of model release. |
product_types
|
array |
Filter images to those from one of your product types. Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription. If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. Product ID can be obtained from the GET /products response. |
phrase
|
string |
Free-text search query. |
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
license_models
|
array |
Specifies the video licensing model(s). |
keyword_ids
|
array |
Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned. |
frame_rates
|
array |
Provides filtering by video frame rate (frames/second). |
format_available
|
string Allowed values: - sd - hd - 4k |
Filters according to the digital video format available on a film asset. |
fields
|
array |
Specifies fields to return. Defaults to 'summary_set'. |
editorial_video_types
|
array |
Allows filtering by types of video. |
collections_filter_type
|
string Allowed values: - include - exclude |
Provides searching based on specified collection(s). |
collection_codes
|
array |
Provides filtering by collection code. |
age_of_people
|
array |
Provides filtering according to the age of individuals in a video. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsSearchVideoSearchResultsGettyImagesModelsArtistsVideoSearchItem
|
object |
videos
|
array [GettyImagesModelsArtistsVideoSearchItem] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_count
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facets
|
EnterpriseProxiesPublicV3ControllersSearchFacetsSearchFacetsResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Use this endpoint to report the usages of a set of assets. The count of assets submitted in a single batch to this endpoint is limited to 1000. Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. In this case, you will need to remove the invalid asset Ids from the query request and re-submit the query.
You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.
Note: Date of use can be in any unambiguous date format.
Name | Data Type | Description |
---|---|---|
id
|
string |
Specifies a unique batch transaction id to identify the report. |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Name | Data Type | Description |
---|---|---|
report_usage_batch_request
|
object |
Specifies the request information for the Batch Usages endpoint. |
asset_usages
|
array [asset_usage] |
Identifies the list of asset id, usage count and date of usage combinations to record. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
report_usage_batch_response
|
object |
Specifies the response from the Batch Usages endpoint. |
total_asset_usages_processed
|
integer |
Specifies the number of asset usage records that were successfully recorded. |
invalid_assets
|
array [string] |
Identifies a list of asset ids submitted that did not match known Getty asset ids. |
Name | Data Type | Description |
---|---|---|
id
|
string |
A video id. |
Name | Data Type | Description |
---|---|---|
page_size
|
integer |
Specifies page size. Default is 30, maximum page_size is 100. |
page
|
integer |
Identifies page to return. Default is 1. |
fields
|
array |
comma delimited list of fields to retrive for the videos |
Name | Data Type | Description |
---|---|---|
Authorization
|
string |
Provide access token in the format of 'Bearer {token}'. |
Accept-Language
|
string |
Provide a header to specify the language of result values. |
Name | Data Type | Description |
---|---|---|
GettyImagesModelsArtistsVideoSearchResults
|
object |
videos
|
array [GettyImagesModelsArtistsVideoSearchItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_count
|
integer |