GET /v3/search/videos/editorial

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.

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.

Search requests without a phrase parameter are not supported and may not always work.

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 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"
    ]
}

Detail Fields Set

The detail_set query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of 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",
        "event_ids",
        "license_model",
        "mastered_to",
        "originally_shot_on",
        "product_types",
        "quality_rank",
        "shot_speed",
        "source",
        "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 video 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.

{
    "videos":
    [
        "display_sizes": 
        [
            {
                "is_watermarked": <boolean>,
                "name": "comp",
                "uri": "<link>"
            },
            {
                "is_watermarked": <boolean>,
                "name": "preview",
                "uri": "<link>"
            },
            {
                "is_watermarked": <boolean>,
                "name": "thumb",
                "uri": "<link>"
            }
        ]
    ]
}

Servers

https://api.gettyimages.com

Request headers

Name	Type	Required	Description
`GI-Country-Code`	String	No	Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
`Accept-Language`	String	No	Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).

Query parameters

Name	Type	Required	Description
`max_clip_length`	Integer	No	Provides filtering by maximum length of video clip, in seconds Default value: 0
`include_related_searches`	Boolean	No	Specifies whether or not to include related searches in the response. The default is false. Default value: false
`page_size`	Integer	No	Specifies page size. Default is 30, maximum page_size is 100. Default value: 30
`keyword_ids[]`	Array	No	Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned.
`viewpoints[]`	Array	No	Filter based on viewpoint.
`include_facets`	Boolean	No	Specifies whether or not to include facets in the result set. Default is "false".
`sort_order`	String	No	Select sort order of results. The default is best_match Valid values: `"newest"` `"most_popular"` `"oldest"` `"best_match"` `"random"`
`artists`	String	No	Search for videos by specific artists (free-text, comma-separated list of artists).
`release_status`	String	No	Allows filtering by type of model release. Valid values: `"release_not_important"` `"fully_released"`
`compositions[]`	Array	No	Filter based on video composition.
`facet_max_count`	Integer	No	Specifies the maximum number of facets to return per type. Default is 300. Default value: 300
`min_clip_length`	Integer	No	Provides filtering by minimum length of video clip, in seconds Default value: 0
`phrase`	String	No	Free-text search query.
`facet_fields[]`	Array	No	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.
`date_to`	String	No	Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31).
`download_product`	String	No	Filters based on which product the asset will download against. 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 download_product value would be premiumaccess:1234. Product ID can be obtained from the GET /products response.
`fields[]`	Array	No	Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate.
`event_ids[]`	Array	No	Filter based on specific events
`collection_codes[]`	Array	No	Provides filtering by collection code.
`page`	Integer	No	Identifies page to return. Default is 1. Default value: 1
`frame_rates[]`	Array	No	Provides filtering by video frame rate (frames/second).
`orientations[]`	Array	No	Return only videos with selected orientations.
`date_from`	String	No	Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31).
`format_available`	String	No	Filters according to the digital video format available on a film asset. Valid values: `"hd"` `"4k"` `"hd_web"` `"sd"`
`specific_people[]`	Array	No	Allows filtering by specific peoples' names.
`image_techniques[]`	Array	No	Filter based on image technique.
`collections_filter_type`	String	No	Use to include or exclude collections from search. The default is include Valid values: `"include"` `"exclude"`
`editorial_video_types[]`	Array	No	Allows filtering by types of video.
`aspect_ratios[]`	Array	No	Search for videos by specific aspect ratios.
`age_of_people[]`	Array	No	Provides filtering according to the age of individuals in a video.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.