Yos Hub API 使用教程

1. 安装 Node.js —— 点此跳转，按系统下载安装包。
2. 创建 API Key —— 登录 YosHub → API Keys → 创建令牌，复制完整的 sk-xxx。
3. 下载 CC Switch —— 点此跳转，用它一键导入配置。
4. 选择客户端 —— 按需配置 OpenAI 兼容客户端 / Claude Code / WorkBuddy / ZCode / Hermes Agent。
5. 发送测试消息 —— 看到 AI 回复就说明接通了～

CC Switch 下载

从 YosHub 一键导入配置

YosHub 支持把供应商配置一键导入到 CC Switch。导入后可直接应用到 Codex、Claude Code、OpenClaw、Hermes 等工具，不用手动编辑多个配置文件。

1. 先在 Yos Hub API Keys 创建或复制 API Key。

   

2. 打开 YosHub 提供的「CC Switch」一键导入入口。

   

3. 系统会唤起 CC Switch，进入供应商导入流程。按需勾选要写入的工具：Claude Code、Codex、Gemini。

   

4. 点击保存并切换为当前供应商。

手动创建配置（可选）

如果不用一键导入，也可以手动创建：

1. 打开 CC Switch，点击右上角「创建新配置」。
2. 按工具类型选择 Codex、Claude Code、OpenClaw 或 Hermes。
3. 填入 Yos Hub API Key 和请求地址：
   • Codex / OpenAI 兼容工具：https://api2.yoshub.com/v1。
   • Claude Code：https://api2.yoshub.com，不带 /v1。
4. 点击「高级选项」打开模型选择页面。
5. 点击「获取模型列表」，把获取到的模型名称填入待配置的模型项。
6. 点击「保存」生成配置并使用。

最终设置参考

完成一键导入或手动配置后，可按下面三张图核对 Codex 的设置。点击图片可放大查看。

1. 供应商配置

供应商名称填写 YosHub，API 请求地址填写 https://api2.yoshub.com/v1，API Key 使用你自己的密钥。默认模型以图中的 gpt-6-astra 为例，实际请填写你的令牌可用的模型名称。

2. 高级选项

展开「高级选项」，将上游格式设为 Responses（原生）。自定义 User-Agent、Header 覆盖和 Body 覆盖没有特殊需要时保持默认即可。

3. 通用设置

进入「设置 → 通用」，如需保留官方登录并统一会话列表，可参考图中开启「非接管切换时保留官方登录」和「统一 Codex 会话历史」。其余通用选项按自己的使用习惯设置。

生效规则

CC Switch 能管什么

• 统一管理 Codex、Claude Code、OpenClaw、Hermes 等工具的供应商配置。
• 一键导入供应商配置，减少手动改 JSON、TOML 或环境变量。
• 通过 Deep Link 导入供应商、MCP 服务器、提示词和技能。
• 支持系统托盘快速切换供应商。
• 支持 MCP 和 Skills 管理，适合多工具、多模型用户长期使用。

官方入口

桌面版安装

手机版

App Store / Google Play 搜索「ChatGPT」，认准开发者 OpenAI。

第一步：安装 Claude Code

macOS / Linux 优先使用官方原生安装脚本：

curl -fsSL https://claude.ai/install.sh | bash

Windows PowerShell 使用：

irm https://claude.ai/install.ps1 | iex

macOS 也可以通过 Homebrew 安装：

brew install --cask claude-code

npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com

第二步：设置 YosHub 凭证

macOS / Linux 当前终端执行：

export ANTHROPIC_AUTH_TOKEN="sk-你的YosHub密钥"
export ANTHROPIC_BASE_URL="https://api2.yoshub.com"

Windows PowerShell 永久写入当前用户环境变量：

[Environment]::SetEnvironmentVariable(
  "ANTHROPIC_AUTH_TOKEN", "sk-你的YosHub密钥", "User"
)
[Environment]::SetEnvironmentVariable(
  "ANTHROPIC_BASE_URL", "https://api2.yoshub.com", "User"
)

第三步：测试

claude --version

看到版本号后运行 claude。能正常读取模型并回复，就说明配置完成。

附录：Claude Code 请求地址说明

第一步：下载 Visual Studio Code

第二步：把 VS Code 切换成中文

1. 打开 VS Code → 左侧点击「扩展」图标（Ctrl + Shift + X）。
2. 搜索 Chinese → 找到 Chinese (Simplified) Language Pack（发布者 Microsoft）→ 点击 Install。
3. 安装后右下角弹出提示 → 点击 Change Language and Restart 重启生效。

第三步：安装官方 AI 插件

第四步：确认接入

插件装好后，先确认 CC Switch 已启动并选中 YosHub 线路，再回到 VS Code。

第五步：测试一次

1. 左侧活动栏找到 ChatGPT / Claude Code 图标，打开面板。
2. 输入测试消息：请用中文回复：你好，帮我确认 VS Code 插件已经可以正常连接使用。
3. 能正常收到回复就说明配置成功 ✨

Linux 特别说明

code --version
node -v && npm -v
code --install-extension OpenAI.chatgpt
code --install-extension Anthropic.claude-code

配置前准备

• 安装并登录 WorkBuddy，确认版本支持「设置 → 模型 → 添加模型」。
• 在 YosHub API Keys 创建一个专用于 WorkBuddy 的 API Key。
• 在 模型广场确认当前分组支持的模型，并复制准确的模型名称。
• 准备 OpenAI 兼容接口地址：https://api2.yoshub.com/v1。

第一步：复制 YosHub API Key 与接口地址

1. 登录 YosHub，进入「API 令牌 / API Keys」页面。
2. 确认令牌状态为启用，并且分组包含准备使用的模型。
3. 点击 API Key 右侧复制按钮；同时复制页面顶部提供的 OpenAI 兼容接口地址。

第二步：打开 WorkBuddy 模型设置

1. 在 WorkBuddy 主界面点击左下角头像或账户入口。
2. 在弹出的菜单中点击「设置」。
3. 进入设置后，在左侧选择「模型」。

第三步：添加自定义模型

1. 打开「模型」页面，找到「自定义模型」。
2. 点击右上角「+ 添加模型」。
3. WorkBuddy 会打开「编辑模型」弹窗；保存后配置会出现在「自定义模型」分组中。

第四步：填写 YosHub 模型参数

第五步：选择自定义模型并测试

1. 保存模型后返回 WorkBuddy 新建任务页面。
2. 点击输入框右下角当前模型名称（例如「Auto」）。
3. 在「自定义模型」分组中选择刚添加的模型。
4. 发送测试消息：请用中文回复：连接成功，并简要说明你当前可以处理什么任务。
5. 能正常收到回复，且 YosHub 控制台出现对应调用记录，即表示配置成功。

配置保存与数据流向

• 官方文档说明，自定义模型配置和 API Key 保存在本地模型配置文件中，不上传 WorkBuddy 云端。
• 使用自定义模型时，WorkBuddy 将请求转发到你配置的模型服务；模型费用由对应服务方计费。
• Windows 界面会显示本地配置文件位置，例如 %USERPROFILE%\.workbuddy\models.json。日常增删改请优先使用图形界面。

配置前准备

• 安装并打开 ZCode；自定义模型供应商功能可通过「设置 → 模型设置」进入。
• 在 YosHub API Keys 创建一个专用于 ZCode 的 API Key。
• 在 模型广场确认当前分组支持的模型，并复制准确的模型 ID。
• 确认模型所属系列：GPT/OpenAI 系列与 Claude 系列使用不同的 API 格式和 Base URL。

第一步：进入模型设置并添加供应商

1. 在 ZCode 主界面点击左下角齿轮按钮。
2. 在设置左侧选择「模型设置」。也可以从聊天框的模型选择器进入「管理模型」。
3. 在「自定义供应商」下点击「+ 添加供应商」。

第二步：填写供应商信息并选择正确协议

1. 「名称」填写便于识别的名称，例如 Yos Hub API 算力中心。
2. 「Base URL」按上表填写；如 YosHub 控制台为你提供了专用线路，则替换域名，但保留对应的路径规则。
3. 「API Key」粘贴完整的 sk-...，不要带引号或前后空格。
4. 「API 格式」必须按模型系列选择，不能只看截图照抄。

第三步：手动添加模型

1. 点击「模型列表」下方的「+ 添加模型」。如果 ZCode 未自动加载模型，就使用此方式手动添加。
2. 「模型 ID」填写模型广场中的准确名称；截图示例为 gpt-5.6-sol。
3. 「上下文窗口」按模型实际能力填写。截图中的 1000000 仅用于演示，不代表所有模型都支持 1M 上下文。
4. 「高级」中的输出上限通常留空即可；只有模型文档明确要求时再填写。
5. 点击弹窗中的「保存」。

第四步：保存供应商

1. 确认模型已出现在「模型列表」中。
2. 再次检查 Base URL、API 格式和模型系列是否匹配。
3. 点击页面底部「添加供应商」完成保存。

第五步：选择模型并测试连接

1. 返回 ZCode 新建任务页面，点击输入框右下角的模型名称。
2. 先选择供应商 Yos Hub API 算力中心，再选择刚添加的模型。
3. 发送测试消息：请用中文回复“连接成功”，并列出你可以协助完成的三类编程任务。
4. 能正常收到回复，且 YosHub 控制台出现调用记录，即表示配置成功。

配置前准备

• 安装并打开 Hermes Agent 中文社区桌面版。
• 确认 YosHub 钱包余额充足。
• 在 YosHub API Keys 创建一个专用于 Hermes Agent 的 API Key，并确认 Key 已启用、未过期且额度充足。
• 在 模型广场确认当前 Key 分组可用且支持 OpenAI Chat Completions 的模型，并复制准确的模型 ID。
• Base URL 使用 https://api2.yoshub.com/v1。也可先阅读线路与接口地址。

第一步：进入自定义模型配置

1. 在 Hermes Agent 顶部导航中点击「配置」。
2. 在左侧菜单中选择「模型」。
3. 在「预设供应商」区域点击「+ 自定义配置」。

第二步：填写 YosHub 服务商信息

第三步：添加并选中模型

1. 填写有效 API Key 后，等待 Hermes Agent 加载模型列表；截图中显示已加载 5 个模型。
2. 确认默认模型与模型广场中的 ID 完全一致。
3. 点击右下角「添加并选中」，同时保存供应商并将该模型设为当前模型。

第四步：发送消息验证连接

1. 返回「工作台」或「消息接入」，新建一个对话。
2. 检查输入框底部的模型名称，确认当前已选中刚添加的模型，例如 gpt-5.6-sol。
3. 发送测试消息：你好。能像截图一样收到正常中文回复，即说明客户端已连通。
4. 能正常收到回复，且 YosHub 控制台出现对应调用记录，即表示基础对话配置成功。

配置与凭证说明

• 桌面版说明显示 API Key 保存在本机配置中；仍应按敏感凭证管理，不要共享配置文件。
• 模型调用会发送到你配置的 YosHub 接口，费用和可用模型以 YosHub 账户、令牌分组及模型广场为准。
• 需要更换模型时，返回「配置 → 模型」，修改当前供应商或选择其他已配置模型。

先准备 Key，选好生图模型

1. 在 YosHub 控制台准备有余额的 API Key，分组选择「生图/视频专用」，并在 模型广场确认模型可用。
2. 确定图片内容、分辨率和画幅。下面是方图的目标尺寸示例；横图、竖图也可以直接告诉 AI 你想要的比例和尺寸。
3. 选择下面任一种方式：复制话术发给 AI，或下载 TXT，填好后交给 AI。

方式一：直接把这段话发给 AI

复制后，把 Key 换成自己的，再修改画面内容。下面以 1K 方图为例；要生成 2K / 4K，按上表替换“模型”和“目标尺寸”。

请使用下面的接口，直接生成图片并保存为 PNG 文件。

API Key：在这里填入你自己的 Key
API 地址：https://api2.yoshub.com
接口类型：OpenAI Images（图片生成）
请求方式：POST /v1/images/generations
模型：gpt-image-2
目标尺寸：1K 方图，size=1024x1024
数量：1 张
画面内容：一只戴围巾的橘猫坐在窗台看雪，室内暖色灯光，细腻插画风。

请以 Bearer 方式使用此 Key，向上述图片生成接口发起请求。
返回 b64_json 时请解码保存；返回图片 URL 时请下载保存。
完成后给我图片文件、实际像素尺寸和使用的模型名称。
不要在回复、截图或示例代码中展示完整 Key。

方式二：保存成 TXT，以后重复使用

下载模板，在自己的电脑上填入 Key，保存为 生图接口.txt。每次将文件上传给 AI；支持读取本地文件的 AI 助手，也可以直接读取你指定的文件路径。

把文件交给 AI 后，可以这样说：

请读取我提供的「生图接口.txt」，按里面的 Key、API 地址和接口类型调用生图接口。
这次使用 gpt-image-2-2K/4K 专用模型，生成 1 张 4K 方图，目标尺寸 4096x4096。
画面内容：一只戴围巾的橘猫坐在窗台看雪，室内暖色灯光，细腻插画风。
请保存为 PNG，给我图片文件，并确认实际像素尺寸。不要展示完整 Key。

下载文件只包含占位符。填好 Key 的 TXT 请自己保存，仅交给你信任的 AI 工具，不要公开分享。

实际调用示例

下面是一次 1K 生图示例：提供 Key、API 地址和模型后，AI 调用接口，将返回的图片保存为 PNG，并报告实际尺寸 1024×1024。耗时和返回情况以每次调用为准。