CID222 documentation
Install, administer, integrate and develop against the CID222 AI gateway — nine guides, versioned with the product.
- Version: 0.4
- Role: admin_user, normal_user, viewer
CID222 is a multi-tenant AI gateway you run on your own infrastructure. It inspects what your people and applications send to large language models, applies your policy before the provider sees it, and records every verdict against a named account.
This documentation is versioned with the product. The pages in this build describe the code in this build.
Start here
You are installing the appliance. Read requirements and sizing, then network prerequisites, then pick your hypervisor. Finish with the setup wizard and licensing.
You are running the appliance day to day. Start at what CID222 is for the shape of the product, then access control and tenants to get the right people the right accounts, then input filters to set the policy. When something breaks, go to troubleshoot and diagnose.
You are calling the API from your own code. Start at the developer introduction, then authentication and the chat API. The error-handling guide is worth reading before you ship.
The guides
| Guide | What it covers |
|---|---|
| Overview | What CID222 is, the deployment modes, the architecture, the packages and the detection engines |
| Install and activate | Sizing, network prerequisites, installing on each hypervisor, first boot, licensing, TLS, updates, hardening and backup |
| Administer | One page for every page of the dashboard, from tenants and filters to compliance and system updates |
| Deploy and integrate | Putting CID222 in the traffic path: the inline proxy, third-party gateways over ICAP, the endpoint agent, the browser extension and the Claude Code plugin |
| Develop | The REST and streaming API: authentication, chat, sessions, detection, files and models |
| Security and compliance | The detection pipeline, the entity and label catalogues, data handling, and the regulatory mapping |
| Troubleshoot and diagnose | The diagnostic snapshot, the health matrix and the guided runbooks |
| Release notes and upgrade | What changed in each version and what an upgrade requires of you |
| Reference | The generated tables: settings, ports, roles, capabilities, licence tiers, event types and error codes |
Before you plan a deployment
Two things decide most of a deployment and are easy to assume wrongly.
- Which traffic you can see depends on where CID222 sits. An API gateway covers applications that address it. Seeing a browser go to a provider's website is a different deployment with different prerequisites. Read deployment modes first.
- Which capabilities you have depends on your licence, not the image. There is one release image and three packages. Read packages and licence tiers.
What changed
Release notes lists what is new, what was fixed and what an upgrade changes, one page per version.
Last updated on