Skip to content

OpenCode 接入 XXAPI ​

让 AI 帮你完成配置

首次安装或切换到 XXAPI,都可以使用。

打开豆包 ↗

AI 打不开链接时,。

查看短提示词

OpenCode 是终端里的编程助手。先把 XXAPI 加到它的服务商列表,再选择模型,就可以开始对话。

1. 安装 OpenCode ​

先完成 Node.js 安装,然后在终端运行。

sh
npm install -g opencode-ai
opencode --version

出现版本号,就可以继续。Windows 原生终端与 WSL 是两个环境,请在以后准备使用 OpenCode 的那个环境里安装和配置。

2. 把密钥交给 OpenCode ​

打开 XXAPI 的 API 密钥,复制自己的 Key。在终端输入 opencode,进入后输入下面这个命令。

text
/connect

选择 Other / 其他服务商,服务商 ID 填 xxapi,再粘贴 API Key。这个 ID 后面还会用到,请保持全小写。

这里只保存了密钥,还需要下一步告诉 OpenCode 接口地址和模型名称。

3. 添加接口地址和模型 ​

从模型广场选择一个支持 Chat Completions 和工具调用的模型,复制模型 ID。

查看当前可用模型与分组从 XXAPI 后台读取

选择与你的 API Key 相同的分组,再复制模型名称。

打开下面的配置文件。没有文件时新建即可。

使用环境配置文件
Windows%USERPROFILE%\.config\opencode\opencode.json
macOS / Linux / WSL~/.config/opencode/opencode.json

Windows PowerShell 执行下面两行,会创建目录并用记事本打开文件。如果记事本询问是否创建新文件,选择“是”。

powershell
New-Item -ItemType Directory -Force "$env:USERPROFILE\.config\opencode" | Out-Null
notepad "$env:USERPROFILE\.config\opencode\opencode.json"

macOS / Linux / WSL 在终端执行下面两行,使用 Nano 编辑器打开文件。

sh
mkdir -p ~/.config/opencode
nano ~/.config/opencode/opencode.json

Nano 中粘贴内容后,按 Ctrl+O、回车保存,再按 Ctrl+X 退出。Windows 记事本直接保存即可。

如果是一个新文件,把下面内容粘贴进去,将三处 MODEL_ID 全部换成同一个真实模型 ID。

json
{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "xxapi": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "XXAPI",
      "options": {
        "baseURL": "https://xxapi.ai/v1"
      },
      "models": {
        "MODEL_ID": {
          "name": "MODEL_ID"
        }
      }
    }
  },
  "model": "xxapi/MODEL_ID"
}

文件原本有内容时,先另存一份备份。 在原有 provider 对象中新增 xxapi 这一项,把顶层 model 改成 xxapi/你的模型ID。其余服务商和项目设置保留,不要把整份文件覆盖掉。配置里无需再次写密钥,OpenCode 会使用刚才 /connect 保存的密钥。

4. 打开模型并试一句话 ​

退出 OpenCode,再次运行 opencode,输入 /models。找到 XXAPI 下的模型并选中。

配置完成后的 OpenCode 起始界面
配置示意,MODEL_ID 对应你刚填写的模型;新安装但尚未配置时不会显示 XXAPI。
在 OpenCode 中选择模型
XXAPI 模型选择示意。图中有两条示例模型,按本页首次配置只会新增一条;选择自己刚填写的模型 ID。

发送“请只回复:连接成功”。收到回复后,就可以打开自己的项目目录开始使用。

已经配过其他服务商 ​

保留原有配置,只新增 provider.xxapi。/connect 里填写的 ID 必须与配置中的 xxapi 相同。如果某个项目单独配置了 opencode.json,它可能覆盖全局模型;在那个项目里重新用 /models 选择,或检查项目配置。

遇到问题 ​

看到的情况处理方法
/models 找不到 XXAPI检查文件位置、JSON 格式和 provider.xxapi,保存后重启 OpenCode
提示没有 API Key再运行 /connect,Other 的 ID 必须是 xxapi
MODEL_ID 不存在示例里的三处占位文字都要替换,不能只改显示名称
404 或不支持的接口Chat Completions 使用本页配置;Responses 模型按下面的说明调整
有回复,但工具执行失败检查模型是否支持工具调用,再用新会话测试
使用 GPT / Codex 的 Responses 接口

选择支持 Responses API 的模型,把 provider.xxapi.npm 改成 @ai-sdk/openai,其余地址仍为 https://xxapi.ai/v1,模型 ID 也换成对应值。不要把 wire_api 这样的 Codex 配置字段粘贴到 OpenCode 中。

更习惯点按钮?通过 CC Switch 配置

安装 CC Switch,在顶部选择 OpenCode,点击添加供应商。选择自定义,ID 填 xxapi,名称填 XXAPI,接口地址填 https://xxapi.ai/v1,填入自己的 Key。协议选择与模型匹配的 OpenAI Compatible 或 OpenAI Responses,再添加模型 ID,保存并启用。完成后回到本页第 4 步。

CC Switch 的 OpenCode 配置入口
CC Switch 添加 OpenCode 服务商
XXAPI 自定义供应商表单局部示意。本页主路径使用 OpenAI Compatible,MODEL_ID 替换为真实模型 ID。
启用刚添加的 OpenCode 服务商
展示 CC Switch 中的 OpenCode 入口。

CC Switch 和手动配置选一种维护方式即可,切换前先备份已有配置。

官方文档

从第一步,到第一次成功使用。