Bairav developer documentation
Bairav governs AI agents. It finds them, scores their risk, enforces your policies on what they do, and keeps a tamper-evident record of every governed action. This site shows you how to connect your own software to it.
Choose how to connect
| You want to | Use | Credential | Start here |
|---|---|---|---|
| Govern every model call an application makes | AI Gateway: change one base URL | Gateway key, bst_ | Gateway quickstart |
| Discover agents running on Windows hosts | Sensor | Sensor token, bst_ | Sensor quickstart |
| Feed security events from your own tools | Ingest API | Ingest token, obt_ | Security events |
| Send OpenTelemetry GenAI traces | OTLP receiver | Ingest token, obt_ | OpenTelemetry traces |
| Assess your software supply chain | SBOM upload from CI | Ingest token, obt_ | SBOM upload |
| Automate administration | Portal API | Session token from sign-in | Authentication |
You can combine them. The most common start is the gateway for application calls plus the sensor for discovery.
How the pieces fit
- Discover. Agents appear in the Intake queue from the sensor, the gateway (the first call from a new agent name registers it) or an import.
- Decide. A reviewer approves or rejects each one. Approving assigns a permanent
AGT-######ID and the agent enters the Registry. - Govern. Policies decide each action:
block,require_approval,flagornotify. Try it out shows the effect of a change before you make it. - Prove. Every decision and lifecycle change is written to the Audit ledger, a hash-chained record you can verify and export.
Words used consistently
| Say | Not |
|---|---|
| Agent | bot, assistant |
| Policy | rule, guardrail (a guardrail is one kind of policy) |
| Suspend (reversible) / Block (not reversible) | pause, ban |
| Audit ledger | log, history |
| Intake queue | inbox |
Before you rely on the API reference
The API reference is generated from the Bairav source and published for a chosen set of operations. Request bodies are fully described. Many response bodies are not yet typed in the source, so some operations show an open response schema. The guides give verified response examples for the calls you will use first.
Calls are not versioned: paths are under /api/. Read the changelog before upgrading a deployment.