接入文档 / 客户端

OpenCode

在 opencode.json 添加 OpenAI 兼容供应商。

配置

在项目根目录或 ~/.config/opencode/ 下的 opencode.json 中添加自定义供应商,并在 shell 中 export COMPASS_API_KEY=sk-你的密钥,然后在 OpenCode 里用 /models 选择模型。

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "compass": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "CompassAPI",
      "options": {
        "baseURL": "https://api.compassapi.ai/v1",
        "apiKey": "{env:COMPASS_API_KEY}"
      },
      "models": {
        "claude-sonnet-5-5": { "name": "Claude Sonnet 5.5" },
        "gpt-6.1-sol": { "name": "GPT-6.1 Sol" }
      }
    }
  }
}

把 sk-你的密钥 换成控制台「API 密钥」页创建的密钥。登录后在控制台的 「接入文档」页,示例会自动填入你的密钥。

注意事项

  • @ai-sdk/openai-compatible 走 Chat Completions 接口;需要 Responses 接口的模型可改用 @ai-sdk/openai。
  • models 里只列出你要用的模型 ID,名称以控制台「模型价格」页为准。

验证

发一条简单的请求,然后打开控制台「用量」,能看到这次调用的模型、Tokens 和费用,就说明接通了。报错时对照错误码与限流。