QCode Documentation

Browse the full Claude Code & Codex documentation by category and find what you need fast

Connect in 60 seconds
  1. 1
    Get an API key
    Create a key in the QCode console — one key works on all four endpoints.
    Open console →
  2. 2
    Set the right BASE_URL
    One command writes the config for you, or check the endpoint table to fill it in yourself (which tools need /v1).
    One-command setup → Endpoints & API formats →
  3. 3
    Connect your tool
    Step-by-step per tool: what to install, which file to edit, how to verify.

What are you trying to do?

4 common tasks
Start here
🚀
Get running in 5 minutes
First time? Start here
💰
Spend less, run longer
Choose models, control context, watch billing
🛠️
Troubleshoot & level up
Diagnose errors, then go further

Full documentation index

71 docs
🚀

Getting Started

Get your key, set the right BASE_URL, make your first request 9 docs
💻

Connect Your Tool

Step-by-step setup and a compatibility overview for IDEs, CLIs, desktop apps and chat clients 27 docs
Tool Compatibility Overview
The compatibility matrix behind every integration page on this site: which protocol each tool speaks, whether Claude models work with it, where its configuration lives, and when each page was last verified
CC Switch Setup
Point CC Switch at QCode.cc for Claude Code and Codex CLI: forms, multi-plan switching, coexistence with official login, switches that do not apply, and recovering an overwritten config
Codex Complete Tutorial
From Installation to Mastery — Complete Usage Guide for OpenAI Codex CLI with QCode.cc
Claude Desktop Setup
Configure QCode.cc as a third-party inference gateway in Claude Desktop's developer mode and share a single QCode quota across all your tools
OpenCode Integration
Using OpenCode open-source terminal AI coding assistant with QCode API
OpenClaw Integration
Configure QCode.cc as model providers for OpenClaw: the models.providers block in openclaw.json, the Custom Provider onboarding wizard, and how to verify the connection
Hermes Agent Integration
Point Hermes Agent (Nous Research) at QCode.cc through custom providers in config.yaml: the three transport values, keys in .env, and switching models mid-session
WorkBuddy Integration
Point Tencent WorkBuddy at QCode.cc as a custom model: fill URL, API Key and model id in the UI, then call GPT and China-family models with one cr_ key
Google Antigravity CLI Setup
Configure Google Antigravity CLI (agy) with a QCode.cc key: set modelProvider in settings.json, then point GEMINI_API_KEY and GOOGLE_GEMINI_BASE_URL at QCode's Gemini endpoint
CodeWhale (formerly DeepSeek-TUI) Integration
Connect CodeWhale to QCode.cc: Claude via the anthropic provider, GPT and Chinese models via the OpenAI-compatible provider
Zed Editor Setup
Connect QCode.cc to the Zed editor via the Agent Client Protocol (ACP) or settings.json, enabling the Opus 5 / 4.8 / 4.7 1M-context agent panel and OpenAI-compatible upstreams
ACP Overview
Agent Client Protocol: one setup that works across Zed, Devin Desktop and JetBrains — run Claude Code as an ACP agent with its environment pointed at QCode
VS Code Integration
Use the Claude Code extension and GitHub Copilot custom endpoints in VS Code: installing the extension, the primaryApiKey config, and connecting QCode through chatLanguageModels.json
GitHub Copilot Integration
Use QCode.cc through GitHub Copilot's custom endpoints: chatLanguageModels.json in VS Code 1.122+ with the three apiType values (messages / chat-completions / responses), Copilot CLI BYOK variables, and JetBrains support scope
Trae Integration
Use the Claude Code extension in ByteDance's Trae IDE (including offline install guide for Trae CN)
Cursor Editor Setup
Connect QCode.cc to Cursor IDE with a custom Anthropic / OpenAI Base URL + API Key, including model config, custom-endpoint limitations, and troubleshooting
Cline Integration
Use QCode.cc API with the Cline extension in VS Code
Cherry Studio Integration
Add QCode.cc as a custom provider in Cherry Studio: the Settings-to-Model-Services path, what URL each of the four provider types needs, and why the Agent feature wants an Anthropic-type endpoint
JetBrains IDE Integration
Use Claude Code through QCode in IntelliJ IDEA, WebStorm, PyCharm, GoLand, and other JetBrains IDEs
Devin Desktop (formerly Windsurf) Setup
Windsurf is now Devin Desktop and is built around ACP: attach Claude Code as an ACP agent with its environment pointed at QCode
Gemini CLI Integration Guide
Configure the Google Gemini CLI with a QCode.cc API key — enterprise paid keys; Pro / free tiers were retired on 2026-06-18
Kilo Code Setup
Connect QCode.cc in the Kilo Code VS Code extension: Settings -> Providers -> Custom provider, with Provider API set to Anthropic Messages for Claude
Crush Setup
Add QCode.cc as a custom provider in Charm Crush: type=anthropic plus base_url in crush.json, and use Claude from the terminal
Droid (Factory) Setup
Add QCode.cc as a BYOK custom model in Factory's Droid CLI: provider=anthropic plus baseUrl in ~/.factory/settings.json
Aider Integration
Configure Aider with QCode.cc: Claude over the Anthropic endpoint (anthropic/ prefix), GPT and Chinese models over the OpenAI-compatible endpoint
Connect SillyTavern to QCode
Chat with QCode.cc's Claude / GPT models in SillyTavern; an honest note on whether gpt-image-2 image generation can be connected, plus alternatives
Roo Code Setup
Use QCode.cc from the Roo Code VS Code extension: pick the Anthropic provider, tick the custom base URL, and Claude works
💡

Usage Tips

After it works: choose models, cut costs, manage context, write config files 16 docs
Model Selection Guide
Understand the characteristics and applicable scenarios of different AI models to make the best choice.
Cost Optimization Guide
Master Claude Code's cost control techniques to accomplish more with fewer tokens
Context Management
Understanding and managing Claude Code's context window, and effectively using commands like /compact and /clear
CLAUDE.md Configuration Guide
Using CLAUDE.md to provide Claude Code with project context and coding conventions
AGENTS.md Configuration Guide
AGENTS.md is Codex's project configuration file -- define your AI coding assistant's behavior rules, similar to Claude Code's CLAUDE.md
CLI Tips
34 practical Claude Code CLI tips to boost your development efficiency
Best Practices
Best practices for efficient Claude Code usage, a comprehensive guide from project initialization to team collaboration
Workflow Tips
Efficient Claude Code development workflows to boost team productivity
Dynamic Workflows
Use Claude Code's Dynamic Workflows to orchestrate dozens to hundreds of background sub-agents for repo-wide review, migration, and research — works through QCode
Output formats: json / text / stream-json
Use claude -p's --output-format to handle Claude Code output in scripts and CI — structured json parsing, real-time stream-json event streams, default plain text, with jq and pipe recipes
Permission Configuration
Configure Claude Code's permission modes to control which operations require human confirmation
Adaptive Thinking Configuration Guide
Adaptive thinking on Claude Opus 4.8 / Sonnet 4.6 / Haiku 4.5: thinking + effort parameters, differences from the legacy budget_tokens, and quality vs. cost trade-offs
Chinese Models
Call GLM / Kimi / DeepSeek / Qwen with the same QCode.cc cr_ key: current ids on sale, protocol paths, a curl self-test, and pairing with the Claude 5 family
Image Input (Vision)
Feed images to Claude Code: paste, drag-and-drop, or reference a file path so the model can read screenshots, mockups, architecture diagrams, and charts. Powered by QCode.cc vision models — one API Key works across every endpoint.
gpt-image-2 Image Generation and Editing
OpenAI-compatible gpt-image-2 text-to-image + image-edit API: drop in by switching base_url, multi-region endpoints, unified billing with your QCode key
Use QCode with 9router
Add QCode.cc as a custom provider in 9router, a local multi-provider router, for cross-provider fallback and unified management

Advanced

Hooks, MCP, subagents, headless automation and the SDK 9 docs
📖

Reference

Cheatsheet, error codes, troubleshooting, billing, enterprise and availability 10 docs
Claude Code Cheatsheet
Claude Code one-page cheatsheet — keyboard shortcuts, slash commands, CLI flags, env vars, MCP, Skills, Agents, CLAUDE.md reference
FAQ
Frequently asked questions about Claude Code and QCode.cc
Subscriptions vs API Keys vs QCode Keys
What a Claude Pro / ChatGPT Plus subscription, an official API key, and a QCode cr_ key actually are, how each is billed, and where each works — three independent things that can coexist
Error Code Reference
Reference for QCode.cc API error codes: 400/401/402/403/429/500/502/503/529 semantics, typical causes and proven fixes, including INSUFFICIENT_BALANCE
Troubleshooting Guide
Diagnosis and solutions for common Claude Code problems, helping you quickly locate and fix issues
Billing Description
Understanding QCode.cc's billing methods, pricing data sources, and fee calculation logic
Enterprise Team Guide
The complete guide to the QCode Enterprise Team plan — dedicated domain, sub-key management, ban protection, multi-tool support, team deployment and security
Crypto Payment Guide
Top up QCode.cc with USDT / USDC / BTC and 6 more coins: picking the network, memos, minimum deposits, and what to do when funds do not arrive
Claude Code Feature Availability
Which Claude Code features work with a QCode API key and which do not — each row labelled as measured or inferred
Partner Open API Guide
Once you are an approved QCode partner, manage your reseller account programmatically with an access token: check balance and usage, create and toggle the sub API Keys you resell. Covers the prerequisite, how to apply, auth, endpoint reference, rate limits and security.