Skip to content

Prerequisites

Generate an API key

  1. Navigate to the Settings
  2. Click on the + Create new secret key.
  3. Name the key Quickstart Key.
  4. Click on the Add button.
  5. Copy the key value by pressing on the copy icon.
  6. Export your key value as an environment variable (replacing with your API key):
export ZEN_API_KEY=<your-api-key>

Update Detector Policy

Each API key has a set of associated detector policies. When the API is created all detector policies are default. To update the detector policy for the API key go to the Policy page, select the corresponding API key, and update the policy for the specific detector.

[Client Only] Installation

Supported python version: >3.9

Pip: 

pip install zenguard

Poetry: 

poetry add zenguard

Limitations

Detectors are constantly improving, but there are some limitations:

  • English: the detectors were designed for English inputs. Support for multiple languages is on our roadmap.
  • Conversational: the detectors were designed for conversational use cases.