API v2 · SDK 3
Overview
HEIP documentation explains how to add HEIP to your site, how to read its decisions, and how it handles data. Start with the Quickstart; it takes about 30 minutes.
Start here
- QuickstartA new site to your server's first decision, in observe mode.
- Server APIverify, its response, and every error your server can get.
- Build with AIA prompt and project rules for your coding agent.
What's in the docs
- Overview
- What's in the docs, and how the API is versioned.
- Quickstart
- From a new site to your server's first decision, in observe mode.
- Build with AI
- A prompt and project rules for coding agents.
- Server API
- The calls your server makes, their responses and errors.
- SDKs
- The browser SDK and the Node.js server SDK.
- Security
- Keys, data, retention and disclosure.
- Privacy
- What HEIP collects and never collects.
Stability and versioning
- The API is versioned in the path (
/v2). Breaking changes get a new path, and/v2keeps working, with notice, before it is retired. - New response fields may be added at any time. Ignore fields you don't recognise. Unknown request fields are dropped, not rejected, so a newer SDK never breaks against an older API.
- Each session records the versions of the evaluation logic and policy format that judged it, in a
versionsobject, so a decision can be traced to the logic in force at the time. - The SDKs follow semantic versioning. Pin the version you install.
Was this page clear? Tell us what was missing.