About the MediaGuard API

The MediaGuard API lets you send pre-bid data to HUMAN and receive IVT predictions accordingly. This HTTP-based API mirrors the core features of our gRPC-based SDK.

The MediaGuard API includes two endpoints:

• The default /lookup endpoint expects individual details about a bid request (extracted from an OpenRTB BidRequest object) in its request body. MediaGuard analyzes these details and returns an IVT prediction.
• The /health-check endpoint checks the status of MediaGuard’s servers.

Authentication

The MediaGuard API requires request-level authentication using Basic auth. To authenticate a request, provide an Authorization header with the value Basic base64(username:password).

For example, if your HUMAN Auth ID is whiteops and your HUMAN Auth Key is secret, your Authorization header should be set to Basic d2hpdGVvcHM6c2VjcmV0.

Using curl

You can use curl to access the MediaGuard API. For example, the following command shows how to query the /lookup endpoint using curl and basic HTTP authentication:

1
curl --location --request POST '/lookup' \
2
--header 'Authorization: Basic <base64(username:password)>' \
3
--header 'Content-Type: application/json' \
4
--header 'Content-Encoding: gzip' \
5
--header 'Accept-Encoding: gzip' \
6
--data-raw '{
7
    "ip": {...},
8
    "userAgent": {...},
9
    "url": {...}
10
}'