Authentication

Service authentication

The API supports two authentication methods, which can be used interchangeably on every protected endpoint.

API Key

You can sign up for credentials by submitting the Get API key form.

Pass the API key with every request in the x-api-key header:

response = requests.get(target_api_url, headers={  
    "X-Api-Key": PUT_YOUR_API_KEY_HERE  
})

OAuth 2.0 Bearer Token

The API also accepts OAuth 2.0 access tokens issued by the Adverteyes identity provider (Cognito). Pass the token as a standard Bearer token:

response = requests.get(target_api_url, headers={
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
})

Note: Both methods cannot be used simultaneously — providing both x-api-key and Authorization: Bearer in the same request will result in a 401 response.

OAuth discovery

The API exposes standard OAuth 2.0 / OpenID Connect discovery endpoints so clients can auto-configure without hardcoding any URLs:

• /.well-known/oauth-authorization-server

• /.well-known/openid-configuration

These return all authorization and token endpoint URLs. Clients that support RFC 8414 will use these automatically.

To sign up for Client ID and Client Secret (i.e. register your app) contact us.

Analysing your first media file

Your first analysis involves uploading a video, processing it, and obtaining the performance score along with recommendations. You will use the Adverteyes API operations for video files. For images, follow the same steps using the Adverteyes API operations for image files.

The successful analysis includes the attention potential score at both the media and scene levels, which is the main performance predictor.

The API endpoint is: https://api.adverteyes.ai/