Prerequisites

Before you begin using AI Guard, ensure you have the following prerequisites in place.

OneTrust Requirements

Development Environment

SDK Dependencies

The AI Guard SDK automatically installs the following dependencies:

Information You Will Need

Before integrating the SDK, gather the following from your OneTrust administrator:

• AI Guard Service URL — The hostname or IP address and port of your AI Guard classification service (e.g., https://ai-guard.example.com:4443)
• API Key (Bearer Token) — Your OneTrust API key with Data Discovery scope
• Certificate Pin (optional) — If TLS certificate pinning is used, the base64-encoded SHA-256 hash of the server certificate's public key
• Classification Profile UUID (optional) — If using a specific classification profile rather than the default

📘

TLS Certificate Pinning

If your AI Guard service uses self-signed or internally-signed TLS certificates, your administrator will provide a certificate pin (pin_sha256) for secure communication. See TLS & Certificate Pinning for details.

Verify Your Environment

Run the following to confirm your Python version meets the minimum requirement:

python --version
# Python 3.13.x or higher required

Verify pip is available:

pip --version

What's Next?

Once you have the prerequisites in place:

1. Create an API Key — Generate credentials for SDK authorization
2. Deploy the Light Worker Node — Set up the classification service
3. Install the SDK — Download and install the Python SDK