Three ways to integrate
Pick the mode that matches your stack. They’re not mutually exclusive: most deployments use the reverse proxy for chat traffic and the scan API for batch jobs and agent tool calls.| Mode | Best for | Code change |
|---|---|---|
| Reverse proxy | Apps that already use the OpenAI / Anthropic SDK | Swap one config value (base_url). |
| Scan API | Custom middleware, batch pipelines, non‑LLM text scanning | Two HTTP calls per request. |
| Tool‑call scan | Agent runtimes that execute LLM‑issued tool calls | One HTTP call before each tool_use. |
Reverse proxy
Wire‑compatible passthrough. No code changes beyond
base_url.Scan API
Explicit
scan/input and scan/output calls around your model.Tool‑call scan
Block dangerous tool invocations before they execute.
Quickstart by mode
- Reverse proxy (OpenAI)
- Reverse proxy (Anthropic)
- Scan API
- Tool‑call scan
allow), mutates content (redact), or returns a
provider‑shaped error (block).Authentication
All routes accept any of the following credentials. UseX-API-Key
for the scan API. For the proxy routes, Authorization is
reserved for the upstream provider, so use X-API-Key (OpenAI
clients) or X-Antidote-Key (Anthropic clients).
| Header | Value | Use it for |
|---|---|---|
X-API-Key | ak_live_… | Scan API; proxy when calling OpenAI. |
X-Antidote-Key | ak_live_… or Bearer <jwt> | Proxy when calling Anthropic (x-api-key is taken by the provider). |
Cookie: antidote_session=… | session JWT | In‑app dashboard usage. |
X-Antidote-App-Id | App UUID (see Apps) | Required on every scan / proxy call. Attributes traffic to an App. |
X-Antidote-App-Token | App token | Required when the App has require_signed_token=true. |
runtime_security.scanto call the scan endpoints.runtime_security.viewfor analytics and event reads.runtime_security.manageto manage Apps and configuration.
Where to next
Apps
Per‑surface configuration: thresholds, detectors, custom rules,
tool policy.
Verdicts
What
allow / redact / block mean and how to act on them.Configuration
Workspace and per‑App settings.
Observability
Analytics, events, drift, streaming.

