文档
进入控制台
文档目录
本页目录

集成

桌面与 Web 客户端

本页提供 WorkBuddy、Cherry Studio、Open WebUI 与 CC Switch 的地址、协议和验证方法。Claude Code CLI 的持久配置已归入编码 Agent 配置。

地址与协议速查

客户端填写地址协议或类型
WorkBuddyhttps://api.khaix.net/v1/chat/completionsOpenAI 兼容 · Chat Completions
Cherry Studiohttps://api.khaix.netOpenAI Responses
Open WebUIhttps://api.khaix.net/v1OpenAI · 默认 Chat Completions
CC Switch · Claude Codehttps://api.khaix.netAnthropic Messages
CC Switch · Codexhttps://api.khaix.net/v1OpenAI Responses

各客户端拼接请求路径的方式不同，地址请直接按表填写。有的需要站点根地址，有的需要带 /v1，不能套用同一个格式。

WorkBuddy

WorkBuddy 支持添加自定义 OpenAI 兼容模型。先在 KHaiXAPI 控制台为 WorkBuddy 单独创建 API Key，再按下列内容配置。

  1. 进入 WorkBuddy 的“设置 → 模型 → 添加模型”，提供商选择“自定义 / Custom”。
  2. Base URL（接口地址）填写 https://api.khaix.net/v1/chat/completions。WorkBuddy 此处需要完整的 Chat Completions 请求地址。
  3. API Key 填写在 KHaiXAPI 控制台为 WorkBuddy 创建的独立密钥。
  4. 模型填写 gpt-5.6-sol；需要其他能力时，从模型广场选择当前可用的准确模型 ID。
  5. 保存后在新任务中选择该模型，发送一条简短消息，并在 KHaiXAPI 控制台核对调用记录。

Cherry Studio

建议先从 Cherry Studio 官网更新到当前版本，再按 OpenAI Responses 配置 KHaiXAPI。

界面名称可能随版本调整；如果菜单不同，请以当前版本说明为准，并确认“自定义提供商”和“更多端点”仍可用。

  1. 打开“模型服务”，选择“添加自定义提供商”。
  2. 名称填写 KHaiXAPI，API 地址填写 https://api.khaix.net。
  3. 填写分配给这个客户端的 API Key。
  4. 手工添加文本模型 gpt-5.6-sol。
  5. 打开该提供商的“更多端点”，启用 OpenAI Responses。
  6. 执行连接检测，保存后发送一条文本消息。

Open WebUI

通过 Open WebUI 的 OpenAI Compatible 连接添加 KHaiXAPI。

  1. 以管理员身份进入 Admin Settings → Connections → OpenAI。
  2. 添加连接，URL 填写 https://api.khaix.net/v1，并填写 API Key。
  3. 首次接入使用默认的 Chat Completions；图像生成调用请单独使用图像生成 API，不要在聊天模型中填写 gpt-image-2。
  4. 保存后检查模型列表；未自动出现时，从模型广场确认可用模型，并在 Model IDs (Filter) 中填写对应模型 ID，例如 gpt-5.6-sol。
  5. 新建对话，发送一条文本消息，并在控制台核对调用记录。

CC Switch

CC Switch 可以集中管理 Claude Code 与 Codex 等应用的供应商配置。请从官方 Releases 安装当前稳定版本，并参考官方添加供应商说明完成下列设置。

应用切换器、供应商类型、Fetch Models 与 Full URL Mode 可能随版本调整；界面不一致时，以当前稳定版官方手册为准。

  1. 打开 CC Switch，在顶部应用切换器中先选择要配置的应用，再点击右上角“+”。只配置当前应用时选择“应用专属供应商”；需要复用配置时再选择“统一供应商”。
  2. 供应商名称填写 KHaiXAPI，选择自定义供应商，并为当前应用使用单独创建的 API Key。
  3. 配置 Claude Code 时，API 地址填写 https://api.khaix.net，API 格式选择 Anthropic Messages，主模型可用 claude-sonnet-5 作为示例。若界面提供角色映射，逐项检查 Sonnet、Opus、Fable 与 Haiku/background；所有模型 ID 都必须按模型广场当前内容替换，不要让未配置角色回落到网关未提供的内置模型 ID。Subagent 模型应在 Claude Code 的 settings.json 中另行确认。
  4. 配置 Codex 时，API 地址填写 https://api.khaix.net/v1，API 格式选择 OpenAI Responses，模型填写 gpt-5.6-sol。
  5. 使用 Fetch Models 拉取模型列表；若当前应用或供应商类型不支持自动拉取，就从模型广场确认可用模型并手工填写模型 ID。保存后启用 KHaiXAPI 供应商。
  6. 先运行 Stream Check，成功后再从 CC Switch 启动目标应用。发送一条短消息，并在 KHaiXAPI 控制台核对协议、模型和状态。

验证与安全

  1. 密钥：每个客户端单独创建，便于限制、审计和撤销。
  2. 文字：发送“请回复：连接成功”，核对返回内容和控制台记录。
  3. 地址：遇到 404 时检查 /v1/v1、错误 endpoint 和客户端自动补路径。
  4. 流式与工具：文字接通后逐项开启，协议问题和密钥问题更容易区分。
  5. 日志：截图和支持记录中的密钥只保留少量字符。
  6. 自动执行：支持文件修改或命令执行的客户端，在不可信目录中应保留权限确认。