# Corveil Documentation

> Operator and integration documentation for Corveil, the zero-trust AI gateway and organizational intelligence layer.

Corveil is a zero-trust AI gateway and organizational intelligence layer. This documentation covers connecting sources, managing the credential vault, and pointing AI clients at a Corveil instance.

## Documentation

- [Corveil Documentation](https://corveil.com/docs/): Operator and integration documentation for Corveil — connect sources, manage credentials, and point AI clients at your gateway.
- [Evaluating Corveil](https://corveil.com/docs/evaluating): For a technical evaluator with no account yet — what runs where, where the data flows, and what your team would actually have to set up.
- [Getting Started](https://corveil.com/docs/getting-started): You have an org. Connect Slack or Google Meet, confirm data landed, and see your first result in the graph.
- [Sources](https://corveil.com/docs/sensors/): Per-source setup guides — which credential to create, how to configure each source, provider-side prerequisites, and how to verify.
- [Bitbucket Source](https://corveil.com/docs/sensors/bitbucket): Ingest pull requests, issues, commits, and review activity from a Bitbucket Cloud workspace or an explicit list of repositories.
- [Confluence Source](https://corveil.com/docs/sensors/confluence): Ingest Confluence Cloud pages and comments using an Atlassian API token, scoped by space or CQL.
- [GitHub Source](https://corveil.com/docs/sensors/github): Ingest issues, pull requests, commits, review summaries, and comment threads from GitHub repositories or an entire organization.
- [GitLab Source](https://corveil.com/docs/sensors/gitlab): Ingest merge requests, issues, commits, and comments from GitLab.com or a self-hosted GitLab instance.
- [Google Calendar Source](https://corveil.com/docs/sensors/googlecalendar): Ingest scheduled Google Calendar events across your Workspace using the same domain-wide-delegated service account as Meet and Drive.
- [Google Drive Source](https://corveil.com/docs/sensors/googledrive): Ingest Docs, Sheets, and Slides under a Drive folder using a service account (with optional domain-wide delegation).
- [Google Meet Source](https://corveil.com/docs/sensors/googlemeet): Auto-ingest Google Meet transcripts and participants across your Workspace using a domain-wide-delegated service account.
- [HubSpot Source](https://corveil.com/docs/sensors/hubspot): Ingest HubSpot CRM objects — companies, contacts, deals, tickets — plus the engagement stream of notes, emails, calls, meetings, and tasks.
- [Jenkins Source](https://corveil.com/docs/sensors/jenkins): Ingest Jenkins CI/CD build results via an inbound webhook — no outbound polling, so on-prem Jenkins works through any firewall.
- [Jira Source](https://corveil.com/docs/sensors/jira): Ingest Jira Cloud issues and changelog activity using an Atlassian API token, scoped by project or JQL.
- [Choosing a Meeting-Capture Path](https://corveil.com/docs/sensors/meeting-capture): Google Meet and Google Drive both ingest Gemini meeting notes. How the two paths differ, why your note-taking policy — not Corveil config — sets the capture footprint, and which path to pick.
- [Microsoft Teams Source](https://corveil.com/docs/sensors/microsoftteams): Ingest Teams channel messages, threads, and meeting transcripts through Microsoft Graph using an Entra ID app registration.
- [Outlook Calendar Source](https://corveil.com/docs/sensors/outlookcalendar): Ingest Outlook / Microsoft 365 calendar events through Microsoft Graph, reusing the app registration Teams and SharePoint already use.
- [S3 Bucket Source](https://corveil.com/docs/sensors/s3): Ingest documents, exports and reports from an Amazon S3 bucket — or any S3-compatible store — with a least-privilege IAM policy scoped to one prefix.
- [SharePoint / OneDrive Source](https://corveil.com/docs/sensors/sharepoint): Ingest SharePoint and OneDrive for Business document libraries through Microsoft Graph, reusing the app registration the Teams source already uses.
- [shell-crm Source](https://corveil.com/docs/sensors/shellcrm): Ingest Companies, Contacts, Deals, Partnerships, Opportunities, Contracts, and Follow-ups from a shell-crm deployment.
- [Slack Source](https://corveil.com/docs/sensors/slack): Ingest channel messages from Slack and respond to @corveil mentions via the Events API — bot token for polling, signing secret for chat.
- [Credential Vault](https://corveil.com/docs/credentials): The named credential vault stores org-scoped secrets that sources reference by id, so the raw secret never lands in a source's config row.
- [Client Setup](https://corveil.com/docs/clients/): Point CLIs, IDEs, SDKs, and desktop apps at a Corveil instance so their LLM traffic flows through the gateway.
- [aichat](https://corveil.com/docs/clients/aichat): Point the aichat CLI at Corveil using its OpenAI-compatible client configuration (Direct mode).
- [Claude Code](https://corveil.com/docs/clients/claude-code): Route Anthropic's Claude Code CLI through Corveil in Direct or Passthrough mode.
- [Claude Cowork](https://corveil.com/docs/clients/claude-cowork): Route Claude Cowork's inference through Corveil with a gateway inference config and a keychain credential helper (Passthrough mode).
- [Claude Desktop](https://corveil.com/docs/clients/claude-desktop): Route Claude Desktop through Corveil using the same Anthropic env vars as Claude Code (Direct mode, community-supported).
- [Codex CLI](https://corveil.com/docs/clients/codex-cli): Route OpenAI's Codex CLI through Corveil in Direct mode (env vars) or Passthrough mode (config.toml provider block).
- [curl / direct REST](https://corveil.com/docs/clients/curl-rest): Call Corveil's OpenAI-compatible REST endpoints directly with curl — completions, streaming, and model listing.
- [Cursor IDE](https://corveil.com/docs/clients/cursor): Configure Cursor's OpenAI-compatible endpoint override to route through Corveil (Direct mode).
- [Gemini CLI](https://corveil.com/docs/clients/gemini-cli): Point Google's Gemini CLI at Corveil in Direct mode (Beta — upstream env-var support is still evolving).
- [GitHub Copilot](https://corveil.com/docs/clients/github-copilot): Point GitHub Copilot Chat's Bring-Your-Own-Key model endpoint at Corveil (Direct mode, Beta).
- [LangChain](https://corveil.com/docs/clients/langchain): Route LangChain's ChatOpenAI client through Corveil with two parameters (Direct mode).
- [LiteLLM SDK / Proxy](https://corveil.com/docs/clients/litellm-proxy): Sit LiteLLM in front of Corveil as an OpenAI-compatible endpoint, via the SDK or the Proxy config (Direct mode).
- [LlamaIndex](https://corveil.com/docs/clients/llamaindex): Route LlamaIndex's OpenAI LLM and embedding classes through Corveil with a custom api_base (Direct mode).
- [Node.js OpenAI SDK](https://corveil.com/docs/clients/node-openai): Route every call through Corveil with the official OpenAI Node SDK's custom baseURL (Direct mode).
- [MCP client setup](https://corveil.com/docs/clients/ontology-mcp): Point any MCP-aware client at Corveil's single /mcp endpoint, then read the full MCP reference for auth, namespaces, and the tool catalog.
- [Open WebUI](https://corveil.com/docs/clients/open-webui): Add Corveil as an OpenAI connection in Open WebUI, the self-hosted chat UI bundled with codename-spotlight (Direct mode).
- [OpenClaw](https://corveil.com/docs/clients/openclaw): Route OpenClaw through Corveil in Passthrough mode via a custom Anthropic provider block.
- [OpenCode](https://corveil.com/docs/clients/opencode): Point OpenCode at Corveil with standard OpenAI environment variables (Direct mode).
- [Python OpenAI SDK](https://corveil.com/docs/clients/python-openai): Use the official OpenAI Python SDK against Corveil by pointing base_url at your host (Direct mode).
- [Qwen Code CLI](https://corveil.com/docs/clients/qwen-code): Point Alibaba's Qwen Code CLI at Corveil with OpenAI-compatible environment variables (Direct mode).
- [Retool Assist](https://corveil.com/docs/clients/retool-assist): Point self-hosted Retool Assist at Corveil via AI proxy environment variables (Direct mode, Beta).
- [corveil CLI](https://corveil.com/docs/cli): Install and authenticate the corveil CLI, then walk your organization's knowledge graph from the terminal — discovery, entity deep-dives, and graph exploration.
- [Ontology Concepts](https://corveil.com/docs/concepts/ontology): The knobs on the Type Registry and Sensor Bindings screens — hydration (deterministic vs LLM), extractor-enabled, and synthesis policy — and how each one decides which entities your sensors produce and what they cost.
- [Roles & Permissions](https://corveil.com/docs/concepts/roles): Corveil's two-role model (admin and member), the last-admin invariant, and a per-surface capability matrix of who can do what inside an organization.
- [MCP](https://corveil.com/docs/mcp): Connect any MCP-aware client to Corveil's first-party tools over a single Streamable HTTP endpoint — the organizational knowledge graph, generated insights, and the control plane — with a virtual API key or browser-based OAuth.
- [Plugin SDK](https://corveil.com/docs/plugins): Build custom sources and integrations with the Corveil Plugin SDK when a first-party source doesn't exist yet.