CoderPlanCoderPlan
HomePricingLotteryAbout
Docs/开始使用
Important article

API Key 接入配置教程

在 API 密钥页创建或选择一把 Key,打开「使用密钥」弹窗后用 CC Switch 一键导入或复制配置块,再用一次简单请求验证。

Last updated: 08/09/2026

Browse docs

Docs

  • 开始使用
    • 快速上手
    • API Key 接入配置Important
    • Claude Code 配置
    • Codex CLI 配置
    • Gemini CLI 配置
    • Cursor 配置
    • OpenClaw 配置
    • Hermes Agent 配置
    • Cline 配置
  • 问题排查
    • Anthropic 连接失败
    • Anthropic err_bad_request
    • Codex 401 unauthorized
  • 使用优化
    • RTK 上下文管理
    • Context7 提高准确性
    • 模型选择
    • 成本控制

Docs

  • 开始使用
    • 快速上手
    • API Key 接入配置Important
    • Claude Code 配置
    • Codex CLI 配置
    • Gemini CLI 配置
    • Cursor 配置
    • OpenClaw 配置
    • Hermes Agent 配置
    • Cline 配置
  • 问题排查
    • Anthropic 连接失败
    • Anthropic err_bad_request
    • Codex 401 unauthorized
  • 使用优化
    • RTK 上下文管理
    • Context7 提高准确性
    • 模型选择
    • 成本控制

This article is not available in English yet

This article is not available in English yet. You can view the Chinese source for now.

API Key 接入配置

进入控制台的 API 密钥页,创建或选择一把 Key,点击卡片上的「使用密钥」打开配置弹窗。本机装有 CC Switch 时,在弹窗底部一键导入对应工具;否则按工具和系统复制配置块,写入工具配置文件或环境变量。配置完成后在工具里发送一次简单请求,例如“hi coderplan”,能正常返回即接入成功。

Setup steps

  1. 1

    创建或选择要配置的 Key

    进入控制台的 API 密钥页。还没有 Key 时点击“创建 API 密钥”,按用途选择类型:编程工具(Claude Code、Codex CLI、Gemini CLI)或第三方 Claude 客户端。已经有一把或多把 Key 时不需要重复创建,直接在列表里选择要配置的那一把。

    去管理 API Key
  2. 2

    点击卡片上的「使用密钥」打开配置弹窗

    每张 Key 卡片都有“使用密钥”按钮,点击后打开这把 Key 的专属配置弹窗,弹窗标题会显示当前 Key 的名称。多把 Key 同时存在时,先看弹窗标题确认当前配置目标。弹窗内的配置块会自动带入完整 Key,不需要手动回卡片复制;需要查看完整 Key 时,也可以点击卡片上的脱敏 Key 取回。

  3. 3

    选择一种配置方式

    “使用密钥”弹窗提供的配置方式是并列选择,不需要全部执行:

    1. 推荐:CC Switch 一键导入,适合本机已经安装 CC Switch,希望少手动复制配置的用户。
    2. 推荐:终端一键脚本,复制「终端一键配置」命令到终端执行(已自动带上 Key),按提示选择模型即可,适合远程 SSH、未装 CC Switch 的用户。
    3. 备用:复制配置块,适合 Claude Code、Codex CLI、Gemini CLI、OpenClaw、Hermes Agent 等工具,把弹窗生成的配置文件内容或终端命令写入本机。
    4. 高级:手动填写配置,适合 Cursor、Cline 或其他支持 OpenAI Compatible 的工具,也适合已经熟悉工具设置页的用户。
  4. 4

    方式一:CC Switch 一键导入

    在弹窗顶部选择要导入的工具(Claude Code、Codex CLI 或 Gemini CLI),再点击底部的“一键导入 CC Switch”。浏览器会询问是否打开 CC Switch,确认后 CC Switch 显示导入预览,把当前 API Key、服务地址和默认模型交给 CC Switch 管理,确认导入即完成配置。下面是完整操作流程截图,按顺序对照即可:

    为什么最简单

    如果你已经安装 CC Switch,这通常是几种方式里最省事的一种。你不需要打开终端,也不需要判断 Base URL 应该填哪个字段;页面把配置交给 CC Switch,CC Switch 再统一管理不同工具的供应商、模型和启用状态。适合不想手动改环境变量,也不想在多个工具设置页来回找入口的用户。

    什么时候适合

    适合已经安装 CC Switch,并希望由 CC Switch 统一管理多个工具配置的用户。如果你经常在 Codex CLI、Claude Code、Gemini CLI 之间切换,用 CC Switch 管理会比每个工具分别填写更省心。

    如果没有打开 CC Switch

    点击导入后页面会提示“正在打开 CC Switch”。如果浏览器没有唤起 CC Switch,通常说明本机还没安装 CC Switch,或者系统没有注册 `ccswitch://` 打开方式。这时不需要重新创建 Key,也不代表 API Key 有问题;先下载安装 CC Switch 后再重试,或直接改用方式二复制配置块。

    下载 CC Switch
    1. 1.点击“创建 API 密钥”,按用途选择场景并命名;创建前可以先对比各分组的价格系数。

    2. 2.在 Key 卡片上点击“使用密钥”,打开这把 Key 的配置弹窗。

    3. 3.在弹窗中选择工具和系统,可直接复制配置块;本机装有 CC Switch 时,点击底部“一键导入 CC Switch”。

    4. 4.浏览器会弹窗询问是否打开 CC Switch,点击“打开 / 允许”,确认唤起本机 CC Switch。

    5. 5.CC Switch 打开后会显示导入预览,确认供应商、模型和 API Key 后,点击“导入”即完成配置。

  5. 5

    方式二:复制配置块写入工具

    不依赖 CC Switch 时,弹窗会按工具和系统生成两类配置块:配置文件块(粘贴到工具的配置文件)和终端命令块(写入环境变量)。先在弹窗顶部选择工具(Claude Code、Codex CLI、Gemini CLI、Grok Build、OpenCode、OpenClaw、Hermes Agent),再选择系统(macOS / Linux 或 Windows),逐块复制使用即可。配置块已经带入完整 API Key 和对应 Base URL,不需要手动拼接。

    配置文件块

    第一个配置块对应工具的配置文件:Claude Code 是 `~/.claude/settings.json`,Codex CLI 是 `~/.codex/config.toml`,Gemini CLI 是 `~/.gemini/.env`,Grok Build 是 `~/.grok/config.toml`,OpenCode 是 `~/.config/opencode/opencode.json`,OpenClaw 是 `~/.openclaw/openclaw.json`,Hermes Agent 是 `~/.hermes/config.yaml`(Windows 在 `%LOCALAPPDATA%\hermes\`)。把块内完整内容粘贴到对应文件保存即可;带默认模型的配置块可按需修改。

    终端命令块

    第二个配置块是设置环境变量的命令:macOS / Linux 是 `export` 命令,Windows 是 PowerShell 的 `$env:` 赋值。粘贴到终端或 PowerShell 执行后,当前会话立即可用;要长期生效,把同样的命令追加到 shell 配置文件(如 `~/.zshrc`),或直接使用配置文件块。

    macOS

    `export` 命令只对当前终端会话生效,不修改系统级配置,也不需要 sudo。要每次新开终端都可用,把 export 行追加到 `~/.zshrc` 或当前 shell 对应的用户配置文件。若工具是从旧终端、IDE 或后台进程启动的,重开终端或重启 IDE 后再验证更可靠。

    Windows

    `$env:` 赋值只对当前 PowerShell 窗口生效,不需要管理员权限。要长期生效,可以使用配置文件块,或自行用 `[Environment]::SetEnvironmentVariable` 写入 User scope。已经打开的终端、IDE 或工具进程可能仍然读取旧环境变量;如果配置后请求仍走旧 Key 或旧 Base URL,先新开 PowerShell,再重启 IDE 或对应 CLI 工具。

  6. 6

    方式三:高级手动填写配置

    复制弹窗展示的 Base URL 和 API Key,粘贴到工具自己的设置页。第三方 Claude 客户端的 Key 打开“使用密钥”弹窗后,会直接看到这两个字段的复制块。手动填写不会自动写入任何配置,也不会替你打开工具设置页;你需要知道这个工具在哪里填写服务地址、模型供应商或 API Key。OpenAI Compatible 工具通常使用 `/v1` Base URL;Claude Code、Gemini CLI 等工具按各自字段要求填写。

    适用场景

    适合 Cursor、Cline 或其他支持自定义模型服务地址的工具,也适合你已经知道设置入口,只需要复制 Base URL 和 API Key 的情况。如果你不知道工具设置页在哪里、字段名是什么意思,优先用方式一或方式二会更稳。

    需要你自己判断什么

    手动填写时,你要自己确认工具需要的是 OpenAI Compatible Base URL、Anthropic Base URL、Gemini Base URL,还是单独的 API Host / Endpoint 字段。字段名不同没关系,关键是不要把 `/v1` 随便加到所有工具里,也不要把 API Key 填到 Base URL 字段。

    和方式二的关系

    方式二的配置块就是把常见 CLI 工具的手动填写动作整理好:弹窗知道该写哪些字段,生成好的内容直接复制即可。方式三则保留完整手动控制权,适合工具类型不在自动配置范围内,或者你明确知道自己要改哪个设置项。

    不要混用字段

    API Key 使用 CoderPlan 控制台生成的完整 `sk-` 密钥。Base URL 是否需要 `/v1` 取决于工具类型,不要把同一个地址格式套到所有工具里。

    配置示例 — OpenAI Compatible
    Base URL: https://api.coderplan.ai/v1
    API Key: sk-your-api-key
  7. 7

    发送一次简单请求验证

    配置完成后,运行对应工具并发送一次简单请求,例如“hi coderplan”。能正常返回,说明 Key、Base URL、账户 API 使用额度和模型权限基本可用。Key 卡片上的“未使用”标记会在首次调用后消失,也可以在控制台“用量”页确认调用记录。

    请求失败怎么办

    先确认工具里使用的 Key 和控制台里的是同一把,再检查 Base URL、API 使用额度和当前终端是否读取了新配置。不要同时修改多项配置,每次只改一项再重新发起小请求。

  8. 8

    Key 贴错或泄露时删除重建

    只要完整 API Key 出现在公开聊天、终端录屏、issue、日志或截图里,就应该在控制台删除这把 Key 并重新创建。随后回到 API 密钥页,在新 Key 卡片上点击“使用密钥”重新配置。

FAQ

已经安装 CC Switch,还需要复制配置块吗?

不一定。你可以优先使用“一键导入 CC Switch”,让 CC Switch 管理多工具配置。只有你不想依赖 CC Switch,或需要直接给 Claude Code、Codex CLI、Gemini CLI 写配置文件或环境变量时,才复制配置块。

有多把 API Key 时,怎么确认正在配置哪一把?

看“使用密钥”弹窗的标题,那里会显示当前 Key 的名称。每张 Key 卡片的“使用密钥”按钮只打开对应这把 Key 的配置,配置块里带入的也是这把 Key 的完整内容。

Base URL 什么时候需要 `/v1`?

Codex CLI、Cursor、Cline 等 OpenAI Compatible 工具通常使用 CoderPlan 的 `/v1` Base URL。Claude Code 和 Gemini CLI 按各自字段使用基础 endpoint,不要把 `/v1` 乱加到所有工具里。

API Key 泄露后只清理本地配置够吗?

不够。清理本地配置只能移除你机器上的残留,不能撤回已经暴露出去的 Key。只要 Key 出现在公开位置,就应该在控制台删除并重新创建。

Still have questions?

If anything is unclear during setup, or you have suggestions for CoderPlan, email the team.

Email us[email protected]
Search and article contents

Search docs

Article contents

  • 创建或选择要配置的 Key
  • 选择配置方式
  • 方式一:CC Switch 一键导入
  • 方式二:复制配置块
  • 方式三:高级手动填写
  • 配置后如何验证
  • 如何清理旧配置
  • 常见问题

Related links

  • 快速上手还没创建账号、准备 API 使用额度或生成密钥时,先按快速上手跑通一次调用。
  • Codex CLI 接入教程按 OpenAI Compatible 方式配置 Codex CLI 的 Base URL 和 API Key。
  • Claude Code 接入教程按 Claude Code 字段配置 ANTHROPIC_BASE_URL 和 ANTHROPIC_AUTH_TOKEN。
  • 连接失败排查教程遇到 401、endpoint 错误或环境变量覆盖时,按顺序排查。
CoderPlanCoderPlan

An AI coding service platform for developers, making common tools easier to connect and manage.

[email protected]

Product

  • Pricing
  • Sign up

Docs

  • Quickstart
  • API Key setup

Supported services

  • Claude Code
  • OpenAI Codex / GPT
  • Gemini

About

  • About
  • Contact us
  • Service Status

© 2026 CoderPlan. All rights reserved.

Privacy Policy|Terms of Service|Refund Policy
Checking...We only process service access and usage records; we do not store your code content or conversation bodies.