The following explains how publishers can integrate the Context API.

The Context API can be used for retrieving contextual data across from IRIS.TV, across all devices and formats. The Context API can also be installed in either client or server-side making it CSAI or SSAI compatible.

Installing Context API Call

Calling the API

The Context API call requires two parameters for authentication and one parameter to identify the video. 

The parameters required for authentication are:

  • access_token: token assigned to the publishers parent account (parent media company)
  • client_token: token assigned to the publishers child account (site, app or channel)

One of the following parameters to identify the video:

  • platform_id: the reference ID (GUID) for the individual asset in your CMS you wish to receive contextual or brand-safety data for
  • alt_id: Any other content identifiers that have been mapped by IRIS.TV. This includes the reference ID from your CMS.

Please confirm with your technical account manager on what parameter to use to identify the video.

Here's an example  the Context API call using the platform_id here:

The Context API Response

The API will respond with a video_info field that includes the following:

  • iris_id: the asset's persistent video ID assigned by IRIS.TV

  • context: the contextual data for the asset created by IRIS.TV's context ands brand-safety data partners

See a sample of the Context API response here:

"success": true,
"video_info": {
"iris_id": "iris_098eiman91fue7",
"context": [


After the Integration is Complete

Once the integration is complete and you’re receiving contextual segments, move on to Activating Contextual Data to the Ad Server   in order to add the data into your existing ad workflow.