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.

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 Corveil → Settings → API Keys.
• 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.

CLI tools & coding agents

• aichat
• Claude Code
• Claude Cowork
• OpenClaw
• OpenCode
• Codex CLI
• Gemini CLI
• Qwen Code CLI
• Ontology MCP Server

IDEs & editor extensions

• Cursor IDE
• GitHub Copilot

SDKs & frameworks

• Python OpenAI SDK
• Node.js OpenAI SDK
• LangChain
• LlamaIndex
• LiteLLM SDK / Proxy
• curl / direct REST

Desktop & web apps

• Claude Desktop
• Open WebUI
• Retool Assist