Skip to content

Client Setup ​

These guides show how to point common AI tools at a Corveil instance. Corveil is OpenAI-compatible, so most clients need only a base URL and an API key.

Routing map ​

Each row is one way an organization sends traffic through Corveil: how that app is configured, and where the provider key lives. Guides for the apps that have a route are linked here and listed again below.

Vendor desktop an organization can lock to the gateway ​

AppHow the organization configures itWhere the provider key lives
Claude Desktop and CoworkMDM. Gateway mode and SSO. This profile does not mint a per-person virtual key.Anthropic API key on the organization (AI Gateway → Providers).

Chat the organization hosts ​

AppHow the organization configures itWhere the provider key lives
Open WebUIOne OpenAI connection: base URL plus a virtual key.Corveil provider credential.
Retool AssistAI inside a self-hosted Retool app builder. AI_PROXY_BASE_URL and a virtual key on that deployment. Retool Cloud stays on Retool's model.Corveil provider credential.

Agents the organization builds ​

AppHow the organization configures itWhere the provider key lives
Python OpenAI SDK, Node.js OpenAI SDK, LangChain, LlamaIndex, and curlBase URL plus a virtual key.Corveil provider credential.

Coding tools, same direct-mode shape ​

AppHow the organization configures itWhere the provider key lives
Claude Code, Cursor, GitHub Copilot Chat's custom model, Gemini CLI, OpenCode, Qwen Code, and aichatBase URL plus a virtual key. Copilot still requires a plan that allows a custom endpoint.Corveil provider credential.

Coding tools on the person's own OpenAI sign-in ​

AppHow the organization configures itWhere the provider key lives
Codex (CLI, desktop app, IDE extension)Passthrough: a config.toml provider block with a virtual key in X-Corveil-Key.With the person: their ChatGPT sign-in or OpenAI API key, which Corveil forwards to OpenAI.

Coding tools billed to your AWS account ​

AppHow the organization configures itWhere the provider key lives
Claude Code on Amazon BedrockBedrock mode: ANTHROPIC_BEDROCK_BASE_URL set to the Corveil host plus /v1/bedrock, and a virtual key in AWS_BEARER_TOKEN_BEDROCK. Managed settings for a fleet. Needs byo_bedrock on the organization.The organization's AWS access keys (AI Gateway → Providers). AWS bills that account.

No route ​

AppHow the organization configures itWhere the provider key lives
ChatGPT desktop chat, Microsoft 365 Copilot, the Gemini app, and GrokThese apps have no customer base URL.With the vendor.
A Claude, ChatGPT, or Copilot subscription sign-inThe sign-in stays on the vendor.With the vendor.
Claude Desktop and Cowork in Bedrock modeUse gateway mode on the Anthropic API instead.AWS credentials on the device.
Google's Agent GatewayGoverns Gemini Enterprise egress to tools. It does not send Gemini chat to Corveil.Not stored in Corveil.

What you need ​

  • A running Corveil instance and its base URL (e.g. https://your-corveil-host).
  • A Corveil virtual API key (sk-citadel-…) — create one under People & Access → API Keys. On the Claude Desktop (MDM) SSO profile, people do not hold a key, and gateway traffic bills the organization's Anthropic API key. A virtual-key helper or passthrough helper fleet still places a credential on the device.
  • For OpenAI-compatible clients, remember the base URL usually includes the /v1 suffix.

Direct vs. Passthrough mode ​

  • Direct mode — your Corveil virtual key is the client's API key. Corveil authenticates the request and forwards it upstream using its own provider credentials.
  • Passthrough mode — your own provider key/OAuth token flows upstream, while a separate x-citadel-api-key header authenticates with Corveil for tracking and guardrails. Used by clients (like Claude Code) that support custom headers.

Moving from another product ​

CLI tools & coding agents ​

IDEs & editor extensions ​

SDKs & frameworks ​

Desktop & web apps ​