Documentation

Documentation

Send conversation events. The engine characterizes the deployment, scores every human turn across the Layer Z behavioral dimensions, and writes the User Health Report. These docs show you how to send data in, get intelligence out, and integrate the result into your stack.

Start here

If you're monitoring an AI deployment, the Quick Start gets you from signup to first scored signal in five minutes. If you'd rather see the output before writing code, the Free Behavioral Audit takes a CSV and emails back a full User Health Report.

RecommendedQuick Start · monitor an AI deploymentFive-minute path: signup → API key → POST your first conversation event with `is_ai_actor` + `ai_deployment_archetype` → see Layer Z scores in the Replay Theater.No codeOr upload a CSV/JSONL/JSONNo code required. Free Behavioral Audit accepts up to 4 MB of conversations (~3K typical), returns a User Health Report by email in ~30 minutes.

Reference

Pick the surface that fits your integration. Both SDKs and the REST API are first-class. The SDKs handle polling, retries, and webhook verification on your behalf.

REST API ReferenceEvery endpoint, every field, every response shape. OpenAPI 3.1 spec at /api/v1/openapi.TypeScript SDKOfficial client for Node and the browser. Bearer auth + retries + typed responses + Layer Z fields.Python SDKSync + async clients. Source is published; PyPI release this month.WebhooksReceive intelligence asynchronously. HMAC-signed callbacks for any production deployment.Billing & Rate LimitsPlan tiers, per-key quotas, cost tracking, response headers, backpressure semantics.OpenAPI 3.1 specMachine-readable spec for code generation, Postman, Insomnia, or any OpenAPI tool.

The single standard

Every response BIE produces is held to one standard: does this help the person reading it understand something about their AI deployment they could not have figured out themselves? If the data does not support a particular conclusion, the engine stays silent rather than manufacturing noise. Design your integration with this in mind. Ship fields only when they are present.