Gush API 快速开始

创建 API Key

登录 Gush API 控制台，从左侧导航进入「API 密钥」，点击右上角「创建密钥」。密钥名称只用于自己识别，可以按照用途命名，例如“Codex”“Claude Code”或“生产环境”。

1. 1

   打开 Gush API 控制台，完成注册或登录。

2. 2

   进入「API 密钥」，点击「创建密钥」，填写便于识别的名称。

3. 3

   先不要直接提交，继续完成下一步的分组选择。

选择正确的分组

创建密钥时必须选择分组。分组决定这个 Key 可以调用的平台、模型范围、账号池和计费倍率；选错分组会导致模型不可用、路由到错误平台或返回权限错误。

选择分组后提交创建，并立即保存完整的 sk-... 密钥。已有密钥也可以在列表的“分组”列中点击当前分组重新选择。

推荐：一键导入 CC Switch

创建密钥后，优先使用列表操作栏中的「导入到 CCS」。Gush API 会通过 CC Switch 深链自动带入供应商名称、API 地址、平台、API Key 和用量查询配置，省去手动复制多项参数。

1. 1

   先按照 CC Switch 使用说明完成安装，并开启目标工具的插件接管。

2. 2

   回到「API 密钥」列表，在目标 Key 的操作栏点击「导入到 CCS」。

3. 3

   允许浏览器打开 CC Switch，核对供应商、平台、API 地址与模型，然后保存并设为 Active。

4. 4

   完全重启正在运行的终端、Codex、Claude Code 或编辑器，让新配置生效。

{
  "ANTHROPIC_DEFAULT_SONNET_MODEL": "glm-5.2[1M]"
}

如果使用其他模型，请把 glm-5.2[1M] 替换为该分组实际提供的完整模型 ID。更多说明见 CC Switch → Claude Code 模型映射。

验证配置或发送请求

通过 CC Switch 导入后，重启目标工具并发送一条简单消息。如果需要独立验证 Key，可以使用下面的 OpenAI 兼容请求；模型 ID 必须属于创建 Key 时选择的分组。

curl https://api.gush.cc/v1/chat/completions \
  -H "Authorization: Bearer $GUSH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-sol",
    "messages": [
      {"role": "user", "content": "用一句话解释 API"}
    ],
    "stream": true
  }'

from openai import OpenAI

client = OpenAI(
    api_key="$GUSH_API_KEY",
    base_url="https://api.gush.cc/v1",
)

response = client.chat.completions.create(
    model="gpt-5.6-sol",
    messages=[{"role": "user", "content": "Hello"}],
)
print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.GUSH_API_KEY,
  baseURL: "https://api.gush.cc/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.6-sol",
  messages: [{ role: "user", content: "Hello" }],
});

身份认证

所有 API 请求都需要在 HTTP 请求头中发送 Bearer Token。服务端会根据密钥识别账户、权限和额度。

接口与端点

SDK 配置使用带 /v1 的 Base URL；直接发送 HTTP 请求时，在其后追加具体端点。

模型选择

模型权限以控制台和 GET /v1/models 的返回为准。建议在生产环境中使用返回列表里的精确模型 ID，不要依赖展示名称。

OpenAIgpt-5.6-sol

Anthropicclaude-*

智谱glm-5.2[1M]

流式响应

将请求体中的 stream 设置为 true，服务会通过 Server-Sent Events 持续返回增量内容。请逐行处理 data: 事件，并在客户端断开时及时取消上游请求。

Gush TUI 安装与登录

Gush TUI 是终端里的 AI 编程助手，可以阅读项目、修改代码和执行开发任务。npm 包名是 gush-tui，安装后的启动命令是 gush。

1. 安装并启动

支持 Windows、macOS 和 Linux。先安装 Node.js，版本需为 22.19.0 或更高。在系统终端执行：

npm install -g gush-tui

检查版本，把 your-project-folder 换成你的项目目录，然后启动：

gush --version
cd your-project-folder
gush

也可以使用以下安装方式。脚本会检查 Node.js 版本并从 npm 官方仓库安装；缺少 Node.js 时会提示先安装，不会自动修改系统环境。

pnpm 与 Bun 需要预先安装并配置全局命令目录；pnpm 可用 pnpm setup 配置后重开终端。所有方式启动时都需要 Node.js 22.19+。安装后 gush-tui、gush、gush.cc 均可启动。官网安装页支持切换和复制安装命令。

2. 在 Gush 内完成网页授权

1. 1

   进入 Gush 交互界面后输入 /login，选择「Gush 网页授权」。以下斜杠命令都在 Gush 内输入，不是在系统终端执行。

2. 2

   在打开的网页上登录 Gush 账户，核对终端与网页显示的授权码、设备信息，再确认授权。浏览器未自动打开时，复制终端显示的链接手动访问。

3. 3

   回到终端，从自己的 API Key 列表中选择一个。没有 Key 时，先到控制台创建密钥并选择分组，再输入 /keys 选择。

4. 4

   输入 /model 选择当前 Key 可用的模型，然后开始提问。后续可用 /keys 切换 Key；模型权限与费用取决于 Key 所属分组。

例如输入：“说明这个项目的目录结构，并找出启动入口。”完成授权后，Gush TUI 会保存设备凭证，之后启动可以继续使用，无需每次复制 API Key。也可以手动配置 Key，但下方的设备、签到与重置卡功能需要网页授权登录。

签到、重置卡与账户管理

网页授权登录后，可以在 Gush 内直接输入以下命令：

每天签到

签到开放时，每个账户每天只能领取一次；更换 Key 或设备不会增加次数。日期按北京时间（Asia/Shanghai）计算，零点进入新一天。签到开放时间及赠送金额以官方说明为准。

奖励到账户余额，不会提高 Key 的独立额度上限或订阅限额。余额不足时也可以直接输入 /checkin，这条命令不需要先调用 AI 模型。

使用重置卡

网页授权登录后，可以直接对 Gush TUI 说“查询我的重置卡”或“使用重置卡”。Gush TUI 会查询可用卡片与可重置套餐；存在多个套餐时，需要先选择目标套餐，再明确确认是否重置。

确认后消耗 1 张重置卡，仅重置所选套餐的日额度和周额度，月额度不会变化。每张重置卡自发放起有效期为 30 天，过期卡不能使用；没有有效套餐或有效卡片时不会执行重置。

用自然语言查询

也可以对 Gush TUI 说：“我的账户还剩多少余额？”“查询当前 Key 的用量”“我今天签到了吗？”“帮我签到”或“查询我的重置卡”。Gush TUI 可通过账户工具调用接口并根据返回结果回答；自然语言方式需要可用的模型和调用额度，直接命令适合快速查询和签到。

管理登录设备

打开 个人资料 → 登录设备，找到对应设备并选择退出。该设备之后的请求会失效，需要重新 /login 授权；已经在处理的请求不保证立即中断。

换电脑或不再使用某台设备时，先撤销授权。设备凭证与密码一样需要妥善保管，不要复制到聊天或公开仓库。

远程控制：手机继续工作

人不在电脑前，也可以用手机继续推进 Gush TUI 里的任务。在 Gush 中输入 /gush-remote，终端会生成远程网页链接、二维码和 12 位连接码；点击链接或用手机扫码打开网页，即可远程接管当前会话。

三步开启远程

1. 1

   在 Gush 交互界面输入 /gush-remote，终端会显示远程网页链接（形如 https://remote.gush.cc/tui?code=XXXX）、对应的二维码和 12 位连接码。

2. 2

   两种方式打开远程网页：直接点击终端里的链接，或用手机扫二维码；也可以手动访问 remote.gush.cc 后输入连接码。

3. 3

   连接成功后，手机网页与电脑上的 Gush 实时同步：发送指令、切换模型与会话、查看任务状态，电脑端继续执行。

使用要点

首次连接时网页会展示一次私密连接说明，之后不再重复打扰。重新执行 /gush-remote 会生成新的连接码，旧连接码随之失效。

Gush TUI 更新与排错

在系统终端运行下面的命令更新，随后重新启动 Gush：

npm install -g gush-tui@latest

卸载前，先在 Gush 中执行 /gush-logout，或在个人资料页撤销设备，然后在系统终端执行 npm uninstall -g gush-tui。卸载 npm 包不会自动撤销远程授权。

Codex 安装与配置

Codex App、CLI 和 IDE 扩展会复用同一份本地配置。需要桌面端时可先安装 App，再按下文安装 CLI、配置 Gush API。

1. 安装 Codex App

需要桌面端时，前往 OpenAI Codex 官方页面下载安装包。安装后先完全退出 App，按下文配置好 config.toml 和 auth.json，再重新打开；App 会复用 Codex CLI 的用户目录配置。

官方安装器需要访问 chatgpt.com。如果当前网络无法下载脚本，请切换到下方的 npm 安装方式。

2. 选择 CLI 安装方式

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"

curl -fsSL https://chatgpt.com/codex/install.sh | sh

# 或使用 Homebrew
brew install --cask codex

curl -fsSL https://chatgpt.com/codex/install.sh | sh

node -v
npm -v
npm install -g @openai/codex

3. 验证安装并启动

重新打开终端后检查版本。然后进入你的项目目录并启动 Codex。

codex --version
cd your-project-folder
codex

官方版本首次运行会显示登录方式。使用 Gush API 时，不需要完成 ChatGPT 登录，继续按下一步创建本地 API Key 配置即可。

4. 获取 Gush API Key

1. 1

   登录 Gush API 控制台，进入「API 密钥」。

2. 2

   创建一个便于识别的密钥，复制完整的 sk-... 内容。

3. 3

   妥善保存密钥。下面示例中的 sk-your-gush-api-key 必须替换为你的真实密钥。

5. 创建 Codex 配置文件

在用户目录创建 .codex 文件夹，并在其中创建 config.toml 和 auth.json。Windows 路径为 %USERPROFILE%\.codex，macOS/Linux 路径为 ~/.codex。

model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "Gush API"
base_url = "https://api.gush.cc/v1"
wire_api = "responses"
requires_openai_auth = false
http_headers = { "x-openai-actor-authorization" = "local-image-extension" }

[features]
goals = true

{
  "OPENAI_API_KEY": "sk-your-gush-api-key"
}

6. 在项目中使用 Codex

打开新的终端，进入项目目录并运行 codex。进入交互界面后可以使用 /status 检查当前模型和 Provider，使用 /permissions 设置命令与文件权限。

cd your-project-folder
codex

# 进入 Codex 后输入
/status

7. 安装 VS Code / Cursor 扩展

在扩展商店搜索 Codex，确认发布者为 OpenAI 后安装。扩展会读取同一份 ~/.codex 配置；如果之前登录过其他账户，先在扩展菜单中退出登录，关闭编辑器，完成配置后再重新打开。

更新 Codex

常见安装问题

Claude Code

在终端设置 Anthropic 兼容地址和密钥。环境变量名称以你当前 Claude Code 版本支持的配置为准。

export ANTHROPIC_BASE_URL="https://api.gush.cc"
export ANTHROPIC_AUTH_TOKEN="$GUSH_API_KEY"

OpenAI SDK

现有 OpenAI SDK 项目通常无需修改业务逻辑。把 api_key 替换为 Gush API Key，并将 base_url 设置为 https://api.gush.cc/v1。

使用 CC Switch 管理供应商

CC Switch 是一款跨平台 API 供应商切换工具，可以在一个界面中管理 Claude Code、Codex、Gemini CLI、OpenCode 和 OpenClaw 的 API 配置。适合需要在多个开发工具之间共用或快速切换 Gush API 的用户。

安装与通用配置

1. 1

   安装软件。运行安装包。如果 Windows SmartScreen 拦截，请先确认文件来自官方 Release，再点击“更多信息”与“仍要运行”。

2. 2

   开启插件接管。打开左上角设置，在“通用”中开启“应用到 XXX 插件”。只开启你实际使用的工具，也可以按需启用开机自启。

3. 3

   添加供应商。返回主界面，点击右上角加号。只配置单个工具时，在对应工具标签中添加；多个工具共用时，可以创建统一供应商。

4. 4

   填写并启用。供应商名称填写 Gush API，API Key 使用控制台生成的令牌。保存后点击供应商卡片，确认它处于 Active 状态。

各应用配置

先在 CC Switch 顶部选择目标应用，再按下表填写。模型 ID 应以控制台或 GET /v1/models 的实际返回为准。

Claude Code 模型映射

Claude Code 会按 Sonnet 等内置模型类型发起请求。使用 GLM 等第三方模型时，只填写模型名称可能不会生效，还需要在 CC Switch 的 Claude Code 供应商高级配置或 Env 中设置默认模型映射。例如，将默认 Sonnet 映射到 GLM-5.2：

{
  "ANTHROPIC_DEFAULT_SONNET_MODEL": "glm-5.2[1M]"
}

让切换后的配置生效

每次切换供应商后，关闭并重新打开正在运行的终端或开发工具。若配置没有变化，请依次检查：对应插件接管开关是否开启、供应商卡片是否为 Active、API Key 是否完整，以及请求地址是否出现重复的 /v1。

错误处理

速率限制

具体并发和用量限制以控制台套餐页面为准。遇到 429 时，使用带随机抖动的指数退避策略；不要在固定时间间隔内无限重试。

获取支持

无法通过文档解决时，请发送邮件至 hi@gush.cc。附上请求时间、端点、HTTP 状态码和响应中的请求 ID；不要发送完整 API Key。