Installation¶

pip install zotniq

Requires Python 3.9 or later.

Extras¶

Install command	Adds
`pip install zotniq`	Core SDK — local detection, cloud preflight, CLI
`pip install zotniq[openai]`	OpenAI drop-in wrapper (`zotniq.integrations.openai.wrap_openai`)
`pip install zotniq[siem]`	SIEM forwarders (Splunk HEC, Datadog, webhook, file)
`pip install zotniq[all]`	Everything

Verify the install¶

python -c "from zotniq import Zotniq; print(Zotniq().detect('[email protected]'))"

You should see one Finding of type EMAIL. No network activity, no API key required.

Get an API key (for cloud features)¶

Cloud-augmented decisioning (server-side LLM contextual pass) needs an API key. Get one at app.zotniq.ai/settings/api-keys. Set it via environment variable:

export ZOTNIQ_API_KEY=zot_sk_...

Or pass it directly:

from zotniq import Zotniq
client = Zotniq(api_key="zot_sk_...")

Without a key the SDK runs in local-only mode — regex detection, zero network calls, no signup required.

Supported Python versions¶

Tested on 3.9, 3.10, 3.11, 3.12, 3.13 across Linux, macOS, and Windows. CI matrix at .github/workflows/sdk-ci.yml runs the full test suite on every combination.