Global API parameters

ams_country

Change the country for the asset management.

By default, the country is auto-detected based on the IP address of the API consumer. Changing this value will filter out content geo-blocked for the defined country and will affect the geo-blocking mechanism.

context

Additional call context for this request.

Some resources of the API require that you provide contextual information along with your request in order to return relevant data.

This is especially useful when the API cannot retrieve or guess this additional information by itself.

Contextual information should only be provided when expressly needed by the resource you are trying to query. Values should be passed as an embedded and URL encoded query string.
E.g.: `?field=data&context=key1%3Dvalue1%26key2%3Dvalue2

device_filter

Filter out content and change media assets.

By default, the device is auto-detected based on the user-agent of the API consumer. Changing this value will filter out content not allowed on the defined device.

Possible values: detect web mobile and iptv

family_filter

Enable/disable the “sensitive content” filter.

By default, the family filter is turned on. Setting this parameter to false will stop filtering-out explicit content from searches and global contexts.

You should always check the result’s explicit field when applicable as some contexts may still return those contents.

You should also flag them in your UI to warn the user about the nature of the content.

Possible values: true or false

localization

Change the default localization of the user.

This will affect results language and content selection. Note that changing the localization won’t give access to geoblocked content of the corresponding location. The IP address of the API consumer is always used for this kind of restriction.

You can use a standard locale like fr_FR, en_US (or simply en, it) but you can also provide detect to tell the API to detect the most probable locale based on the consumer’s location.

thumbnail_ratio

Change the size ratio for all video thumbnails.

By default: original
Possible values: original, widescreen and square