Documentation
Everything you need to deploy, configure, and extend the AI-FW gateway, guides, hands-on tutorials, and API references.
Getting Started
Start here: what AI-FW is and how to get your gateway running in minutes.
Guides
Deep dives into each capability: guardrails, routing, semantic analysis, identity, risk, and reliability.
Prompt & response guardrails
How AI-FW inspects every prompt and response, built-in rules, custom rules, evaluation order, and rule actions.
Model routing & registry
How AI-FW decides which model handles a request, the model inventory, default model and backend, strict mode, and conditional routing rules.
Semantic intent analysis
Judge the meaning of AI traffic, not just its text, natural-language policies, block and flag thresholds, and three scoring engines.
Identity & access
Authentication modes, API keys, key precedence, streaming modes, mTLS, Kerberos, OIDC SSO, SCIM, and admin roles.
Risk profiles & auto-block
Rolling risk scores for users, agents, and IPs, with automatic blocking, category risk cards, and a metadata-only audit trail.
Reliability & caching
Per-model resilience (retries, failover, distribution) and the opt-in completion cache, exact and semantic, with strict tenant isolation.
Prompt compression
Cut upstream token spend with semantic-gated prompt compression, rule, aggressive, and LLM tiers that never change the meaning.
Claude inference hooks
Act as the AI security server for Anthropic's Inference Hooks - verified, scanned, and machine-actionable verdicts before inference proceeds.
Observability & dashboard
The AI-FW dashboard - traffic stats, latency, guardrail snapshot, 24-hour metrics, and the live Activity view.
Audit logs & export
The metadata-only audit trail - logging policy, retention, audit events, and exporting to your SIEM via pull API or syslog.
Admin-issued API keys
Issue API keys for agent and tool access - hashed storage, immediate revocation, and per-key identity in the audit trail.
Tutorials
Hands-on walkthroughs that connect real clients to the gateway.
Connect an OpenAI SDK
Point an OpenAI-compatible client at the gateway, endpoint mode for full inspection, proxy mode for convenience.
Claude Code, Cursor & MCP tools
Route Claude-native clients, Cursor, and MCP tools through the gateway, Anthropic protocol support, facades, and the MCP compliance interface.
M365 Copilot admin & agent sync
Manage Microsoft 365 Copilot admin surfaces from AI-FW with app-only auth - agent catalog, agent registry, usage reports, and interaction export.
Agent self-enrollment (CSR + mTLS)
Walk an AI agent through the full enrollment round-trip, discover, register, request a certificate with a CSR, and authenticate with mTLS.
How-To
Focused recipes for common admin tasks.
Configure models & API keys
A recipe for the Model Inventory, add models, set per-model keys, enable them, and understand key precedence.
Create rules with AI assistance
Draft guardrail rules from a plain-language objective, the Rules Manager generates, validates, and lets you review before enforcing.
Deploy on Azure Container Apps
A production-shaped deployment recipe, PostgreSQL, the gateway container, secrets, environment configuration, and health checks.
API Reference
The OpenAI-compatible, Anthropic, and agent-protocol endpoints.
OpenAI-compatible API
The /v1 endpoints, chat completions, request headers, error codes, streaming, and cache headers.
Anthropic Messages API
The /v1/messages endpoint, Anthropic-native chat, x-api-key auth, facades, and streaming.
A2A agent protocol
The Agent2Agent (A2A) surface, the agent card, registration, task-based certificate operations, MCP, and webhooks.
OpenAI-compatible models & endpoints
200+ OpenAI-compatible models and their vendor endpoints - Claude, OpenAI, Azure, Grok, Meta Llama, DeepSeek, AWS Bedrock, Qwen, Z.ai, and more.
Admin Reference
Every admin page and its options: Settings, Model Inventory, Rules Manager, Risk Profiles, Audit, and more.
Settings reference
Every tab of the Settings page - General, Access, Identity, Model, Routing, Guardrails & Inspection, Performance, Audit, Export, Integrations, and Licensing.
Model Inventory reference
The Model Inventory page and every option: filters, enable/disable, add/edit/delete, protocols, resilience, compression, advanced parameters, groups, and routing rules.
Rules Manager reference
Built-in rules, custom rules, rule types and actions, per-rule options, priority, and AI-assisted rule creation.
Risk Profiles reference
User, agent, and IP risk leaderboards, category risk cards, risk auto-block, and reset actions.
Audit Logs reference
The transaction log, filters, the Events tab, and page-size settings.
Dashboard reference
Every card and control on the AI-FW Dashboard - traffic stats, latency, guardrail snapshot, 24-hour metrics, and charts.
M365 Copilot admin reference
The M365 Copilot page - agent catalog, agent registry, usage analytics, and interaction export with app-only authentication.
Users reference
Local users, roles, passwords, SSO, SCIM provisioning, and user groups.
Agent API keys reference
The Agent API Keys page - add, generate, label, and revoke keys with hashed storage and per-key identity.
Agents reference
The agent registry admin page - onboarding modes, identity proof, approval, groups and tags, webhooks, and deboarding.
CA integrations reference
SCEP and ACME enrollment, the central CA trust store, and server-certificate enrollment.
Agent Trust reference
The Agent Trust dashboard - agent inventory, approvals, tasks, and trust settings.
Community Edition
The free edition license, the published monthly token allowance, and how the gateway enforces it.