Skip to content
Olivares AI docs
Search
Ctrl
K
Cancel
Select version
Latest
2026-06 (pre-1.0 preview)
Select theme
Dark
Light
Auto
Select language
English
Español
简体中文
Русский
日本語
Deutsch
Français
Menu
Start here
What is Olivares AI?
Quickstart
Paths by role
How this documentation is organized
Honesty & limits
Tutorials
From zero to a read/write access graph
Getting started by scenario
Get started on a single node (binary + systemd)
Get started with Docker Compose
Get started on Kubernetes (Helm)
Get started in an air-gapped site
How-to guides
Install & operate
Self-host the control plane
Your first hour (local, team, hybrid)
Deploy with Docker
Install from a package
Install with Homebrew
Install air-gapped
Verify a release
Harden a deployment
Back up and restore
Upgrade and roll back
Install a license
Rehearse the commercial cycle
Monitor with Prometheus
Troubleshooting
Connect & observe
Connect a source
Connect Claude Code
Run Claude Code with Olivares
Add a provider and launch an agent
Operate a provider session
Governed data for Claude
Govern Postgres content
Govern your file server
Enterprise OTel for Claude Code
Forward to Splunk
Integration guides
Integrate Claude Code
Integrate Codex
Integrate Grok Build
Connector guides
PostgreSQL pgAudit (clean-tier R/RW)
AWS CloudTrail for S3 (clean-tier R/RW)
eBPF / Tetragon (the kernel backstop)
OpenTelemetry GenAI (any instrumented agent)
Claude Code hooks & enforcement (the PEP)
Anthropic admin plane (usage, cost, compliance)
MCP introspection & registry governance
SSO, SCIM & identity sources (firm attribution)
TAK Server posture & governed Cursor-on-Target ingest
Cookbook
Recipe: deny-closed policies (Cedar / OPA)
Recipe: budgets & FinOps guardrails
Recipe: human-in-the-loop approvals
Recipe: triage least-privilege drift
Recipe: the estate kill switch (and how to drill it)
Recipe: push findings and the ledger to your SIEM
Govern & build
Govern and approve
Build a governed workflow
Manage as code (Terraform)
Use the client SDKs
Build and ship a connector
Reference
Overview
REST API
Olivares AI control plane API
Overview
health
Overview
/healthz
GET
/livez
GET
/metrics
GET
/openapi.beta.json
GET
/openapi.json
GET
/pod-readyz
GET
/readyz
GET
/status
GET
/v1/server-info
GET
auth
Overview
/v1/account/password
POST
/v1/auth/browser-session
GET
/v1/auth/browser-session
POST
/v1/auth/capabilities
POST
/v1/auth/effective-rights
GET
/v1/auth/login
POST
/v1/auth/logout
POST
/v1/auth/os-account-bindings
POST
/v1/auth/os-account-bindings/complete
POST
/v1/auth/os-account-bindings/{id}
GET
/v1/auth/os-account-bindings/{id}
DELETE
/v1/auth/piv/elevate
POST
/v1/auth/piv/status
GET
/v1/auth/refresh
POST
/v1/auth/step-up-policy
GET
/v1/auth/step-up-policy
PUT
/v1/auth/totp
DELETE
/v1/auth/totp/activate
POST
/v1/auth/totp/challenge
POST
/v1/auth/totp/enrol
POST
/v1/auth/totp/policy
GET
/v1/auth/totp/policy
PUT
/v1/auth/totp/status
GET
/v1/auth/webauthn/authenticate
POST
/v1/auth/webauthn/authenticate/options
POST
/v1/auth/webauthn/credentials
GET
/v1/auth/webauthn/credentials/{id}
DELETE
/v1/auth/webauthn/credentials/{id}
PATCH
/v1/auth/webauthn/register
POST
/v1/auth/webauthn/register/options
POST
/v1/auth/whoami
GET
/v1/invites/accept
POST
/v1/setup
POST
/v1/users/{id}/totp
GET
/v1/users/{id}/totp/reset
POST
agents
Overview
/v1/access-edges
GET
/v1/agents
GET
/v1/agents
POST
/v1/agents/{id}
GET
/v1/agents/{id}
DELETE
/v1/agents/{id}
PATCH
audit
Overview
/v1/audit
GET
/v1/audit/export
GET
/v1/audit/pubkey
GET
/v1/audit/recent
GET
/v1/audit/system
GET
/v1/audit/verify
GET
users
Overview
/v1/users
GET
/v1/users
POST
/v1/users/superadmins
GET
/v1/users/{id}/disable
POST
/v1/users/{id}/enable
POST
tokens
Overview
/v1/tokens
GET
/v1/tokens
POST
/v1/tokens/{id}
DELETE
/v1/tokens/{id}/rotate
POST
workspaces
Overview
/v1/workspaces
GET
/v1/workspaces
POST
/v1/workspaces/{id}
GET
/v1/workspaces/{id}
PATCH
/v1/workspaces/{id}/contents
GET
/v1/workspaces/{id}/parent
PUT
/v1/workspaces/{id}/summary
GET
system
Overview
/v1/members
GET
/v1/members/{id}
DELETE
/v1/memberships
POST
/v1/search
GET
/v1/system/orgs
GET
/v1/system/orgs
POST
/v1/system/orgs/{tenant_id}
DELETE
/v1/system/orgs/{tenant_id}/region
PUT
/v1/system/orgs/{tenant_id}/status
PUT
/v1/system/residency
GET
/v1/system/session-idle
GET
/v1/system/session-idle
PUT
/v1/system/tracing
GET
/v1/system/tracing
PUT
connectors
Overview
/v1/connectors/health
GET
console
Overview
/v1/console/activation
GET
/v1/console/activation/apply
POST
/v1/console/activation/preview
POST
/v1/console/bus
GET
/v1/console/config/effective
GET
/v1/console/connectors
GET
/v1/console/connectors
PUT
/v1/console/connectors
DELETE
/v1/console/connectors/test
POST
/v1/console/dr/backup
POST
/v1/console/dr/backups
GET
/v1/console/dr/backups/{id}
GET
/v1/console/dr/backups/{id}
DELETE
/v1/console/dr/backups/{id}/download
GET
/v1/console/dr/jobs
GET
/v1/console/dr/jobs/{id}/stream
GET
/v1/console/dr/restore/pending
GET
/v1/console/dr/restore/upload
POST
/v1/console/dr/restore/{id}/apply
POST
/v1/console/dr/restore/{id}/approve
POST
/v1/console/dr/schedule
GET
/v1/console/dr/schedule
PUT
/v1/console/health-summary
GET
/v1/console/keys
GET
/v1/console/license
GET
/v1/console/license
POST
/v1/console/license
DELETE
/v1/console/logs/buffer
GET
/v1/console/logs/stream
GET
/v1/console/mcp-gateway
GET
/v1/console/mcp-gateway/servers
POST
/v1/console/mcp-gateway/servers/{id}
PUT
/v1/console/mcp-gateway/servers/{id}
DELETE
/v1/console/mcp-gateway/servers/{id}/test
POST
/v1/console/mcp-gateway/session-tools
PUT
/v1/console/modules
GET
/v1/console/modules
PUT
/v1/console/notify-destinations
GET
/v1/console/notify-destinations
PUT
/v1/console/notify-destinations
DELETE
/v1/console/notify-destinations/test
POST
/v1/console/runtime/reload
POST
/v1/console/secrets
GET
/v1/console/secrets
PUT
/v1/console/secrets
DELETE
/v1/console/secrets/generate
POST
/v1/console/secrets/reveal
POST
/v1/console/secrets/totp
POST
/v1/console/setup-status
GET
/v1/console/sources
GET
/v1/console/sources
PUT
/v1/console/sources
DELETE
/v1/console/sources/diff
GET
/v1/console/sso
GET
/v1/console/sso
PUT
/v1/console/sso
DELETE
/v1/console/sso/idps
GET
/v1/console/sso/idps/{alias}
GET
/v1/console/sso/idps/{alias}
PUT
/v1/console/sso/idps/{alias}
DELETE
/v1/console/sso/idps/{alias}/test
POST
/v1/console/sso/tenants/{tenant}
GET
/v1/console/sso/tenants/{tenant}
PUT
/v1/console/sso/tenants/{tenant}
DELETE
/v1/console/sso/tenants/{tenant}/idps
GET
/v1/console/sso/tenants/{tenant}/idps/{alias}
GET
/v1/console/sso/tenants/{tenant}/idps/{alias}
PUT
/v1/console/sso/tenants/{tenant}/idps/{alias}
DELETE
/v1/console/sso/tenants/{tenant}/idps/{alias}/test
POST
/v1/console/sso/tenants/{tenant}/test
POST
/v1/console/sso/test
POST
/v1/console/support-bundle
POST
/v1/console/update-check
POST
/v1/console/updates
GET
/v1/console/updates/apply
POST
directory
Overview
/v1/agent-groups
GET
/v1/agent-groups
POST
/v1/agent-groups/{id}
GET
/v1/agent-groups/{id}
DELETE
/v1/agent-groups/{id}
PATCH
/v1/agent-groups/{id}/members
GET
/v1/agent-groups/{id}/members/{agentID}
PUT
/v1/agent-groups/{id}/members/{agentID}
DELETE
/v1/groups
GET
/v1/groups/{id}/parent
PUT
/v1/groups/{id}/role
PUT
/v1/groups/{id}/workspace
PUT
/v1/invites
GET
/v1/invites/{id}
DELETE
/v1/invites/{id}/resend
POST
/v1/onboard
POST
API stability & deprecation policy
Console screens & permissions
gRPC services & methods
Event bus (AsyncAPI 3.0)
Connectors & coverage tiers
Verified connectors (third-party)
SIEM & telemetry egress
Modules catalog
Overview — the 35 selectable modules
Inventory & discovery
Live operation & sessions
Access & resource map (R/RW)
Orchestration & A2A
MCP, skills & capabilities
Health, SLA & uptime
Live-ingest
Observability
Claude Code adoption
Identity, permissions & governance
Identity
Source & credential scoping
Deployment & integration
Claude Code managed policy
Claude agent confirmations
Model & provider management
Inline inference proxy (PEP)
Internal catalog & marketplace
Skills catalog & assignments
Voice & realtime agents
Security, guardrails & audit
Privileged-session recording
Data, knowledge & context
Compliance & regulatory
SIEM/ITSM forwarder
Posture export to control towers
Reporting (HTML/PDF)
Cost & AI FinOps
Quality, evals & testing
Agent simulation/testing sandbox
Red-teaming & adversarial testing
Output integrations & notifications
Eventing & webhooks
Saved console views
Session cockpit (availability)
API & manage-as-code (platform)
Multi-tenancy & org management (platform)
Executive dashboards & reporting (console)
Model operations (own models)
Fine-tuning & inference execution (planned)
CLI
Configuration
Glossary
Explanation
Overview
The work plane
EU AI Act evidence from runtime data
Architecture
Where Olivares AI fits with your IdP
Architecture overview
Security & threat model
The security model
Threat model (STRIDE / DFD)
Trust & procurement
Positioning & fit
Market context & sources
Analyst vocabulary, mapped honestly
Olivares AI vs LLM gateways & observability (LiteLLM, Langfuse)
Olivares AI vs AI control towers
Higher education & research
Governing subscription-authed Claude Code & Codex
Where Olivares fits vs your AI gateway & Guardrails
Olivares AI vs WitnessAI
Claude apps gateway + Olivares AI co-deployment
Open core & licensing
Supporting the project
Select version
Latest
2026-06 (pre-1.0 preview)
Select theme
Dark
Light
Auto
Select language
English
Español
简体中文
Русский
日本語
Deutsch
Français
Overview
directory
Section titled “ directory ”
Directory: agent groups, provisioned groups, invitations, onboarding
Operations
Section titled “ Operations ”
GET
/v1/agent-groups
POST
/v1/agent-groups
GET
/v1/agent-groups/{id}
DELETE
/v1/agent-groups/{id}
PATCH
/v1/agent-groups/{id}
GET
/v1/agent-groups/{id}/members
PUT
/v1/agent-groups/{id}/members/{agentID}
DELETE
/v1/agent-groups/{id}/members/{agentID}
GET
/v1/groups
PUT
/v1/groups/{id}/parent
PUT
/v1/groups/{id}/role
PUT
/v1/groups/{id}/workspace
GET
/v1/invites
DELETE
/v1/invites/{id}
POST
/v1/invites/{id}/resend
POST
/v1/onboard