GET /v3/videos/{id}/similar
This endpoint will provide a list of videos that are similar to the specified asset id.
You'll need an API key and access token to use this resource.
Working with Fields Sets
Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:
Summary Fields Set
The summary_set query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every 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"
}
],
"download_sizes",
"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
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
A video id. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept-Language |
String | No |
Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Identifies page to return. Default is 1. Default value: 1 |
page_size |
Integer | No |
Specifies page size. Default is 30, maximum page_size is 100. Default value: 30 |
fields[] |
Array | No |
Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate. |
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.