workbuddy 如何接入 chatgpt api

想让 WorkBuddy 使用 ChatGPT API，本质上是把 OpenAI 的兼容接口配置成 WorkBuddy 的自定义模型。新版 WorkBuddy 可以在「设置 -> 模型」里直接添加自定义模型；旧版或团队项目场景，也可以用 ~/.codebuddy/models.json 或项目内 .codebuddy/models.json 配置。

这篇教程适合已经安装 WorkBuddy / CodeBuddy 系列工具，并且希望用自己的 OpenAI API Key 调用 ChatGPT 模型的用户。你需要准备 3 个信息：API Key、接口地址、模型 ID。

先看结论：WorkBuddy 接入 ChatGPT API 要填什么

配置项	推荐填写
Provider / 供应商	OpenAI，或 Custom API
API Key	OpenAI Platform 里创建的 `sk-...` Key
Base URL / URL	`https://api.openai.com/v1/chat/completions`
Model / 模型 ID	优先使用你账号可用的 Chat Completions 模型
Tool Call	如果模型和账号支持工具调用，可以开启
Vision / 图片输入	只有确认模型支持视觉输入时再开启

需要注意：OpenAI 官方新应用开发文档更推荐使用 Responses API，但 WorkBuddy 的自定义模型文档明确要求当前 models.json 使用 OpenAI 接口格式，并且 url 通常要写完整的 /chat/completions 路径。所以在 WorkBuddy 里接入 ChatGPT API 时，重点不是填 https://api.openai.com/v1，而是填完整接口：

text

https://api.openai.com/v1/chat/completions

参考资料：

OpenAI 官方快速开始文档：Developer quickstart
OpenAI 模型列表与选型说明：Models
WorkBuddy 模型配置说明：Model Configuration
CodeBuddy / WorkBuddy models.json 说明：models.json Configuration Guide

第一步：准备 OpenAI API Key

先进入 OpenAI Platform 创建 API Key：

text

https://platform.openai.com/api-keys

创建后不要把 Key 直接发给别人，也不要提交到 GitHub。OpenAI 官方快速开始文档建议把 API Key 放到环境变量里，macOS / Linux 可以这样写：

bash

export OPENAI_API_KEY="sk-your-api-key"

Windows PowerShell 可以这样写：

powershell

setx OPENAI_API_KEY "sk-your-api-key"

如果你只是通过 WorkBuddy 图形界面配置，可以直接把 Key 粘贴到 WorkBuddy 的 API Key 输入框。但如果你要写 models.json，更建议使用环境变量引用，避免明文保存。

第二步：确认你的 ChatGPT API 能正常调用

在配置 WorkBuddy 之前，先用 curl 测一下 OpenAI API 是否能通。这样可以先排除 Key 无效、网络不通、账号没有额度等问题。

bash

curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": "用一句中文回复：WorkBuddy 已经连接到 ChatGPT API。"
      }
    ]
  }'

如果返回 JSON，并且里面有 choices[0].message.content，说明 ChatGPT API 可以正常访问。此时再去配置 WorkBuddy，成功率会高很多。

如果你希望使用更新的 GPT-5 系列模型，请先到 OpenAI 模型页确认你的账号是否可用，并确认该模型是否能通过 Chat Completions 路径调用。OpenAI 官方模型页会持续更新模型 ID、上下文长度、价格和能力；不要只照搬旧教程里的模型名。

第三步：用 WorkBuddy 图形界面接入 ChatGPT API

新版 WorkBuddy 推荐走图形界面，不需要手动编辑配置文件。步骤如下：

打开 WorkBuddy。
进入「设置」。
找到「模型」或「Model」页面。
点击「添加模型」或「Add」。
Provider 选择 OpenAI；如果没有 OpenAI 选项，就选 Custom API。
填入 API Key。
填入模型 ID。
如果界面要求填写 URL，填完整的 https://api.openai.com/v1/chat/completions。
保存配置。
回到对话界面，在模型选择器里切换到刚添加的 ChatGPT 模型。

WorkBuddy 官方文档说明，自定义模型可以在设置页的模型页面通过图形界面管理；选择标准供应商时，工具调用、图片输入、推理模式等能力标记会自动填入。如果你选择的是 Custom API，就需要自己确认这些能力是否真的支持。

第四步：用 models.json 接入 ChatGPT API

如果你的 WorkBuddy 版本还在使用配置文件，或者你想给某个项目单独指定模型，可以使用 models.json。

用户级配置路径：

text

~/.codebuddy/models.json

项目级配置路径：

text

<project-root>/.codebuddy/models.json

项目级配置优先级高于用户级配置，适合团队项目固定模型、固定代理地址或固定能力开关。

最小可用配置

先创建或编辑 ~/.codebuddy/models.json：

json

{
  "models": [
    {
      "id": "gpt-4o",
      "name": "ChatGPT API - GPT-4o",
      "vendor": "OpenAI",
      "apiKey": "${OPENAI_API_KEY}",
      "url": "https://api.openai.com/v1/chat/completions",
      "maxInputTokens": 128000,
      "maxOutputTokens": 4096,
      "temperature": 0.7,
      "supportsToolCall": true,
      "supportsImages": true
    }
  ],
  "availableModels": ["gpt-4o"]
}

然后确认环境变量已经生效：

bash

echo $OPENAI_API_KEY

如果能看到 sk-...，重启 WorkBuddy 或重新打开 CodeBuddy CLI，让配置重新加载。

使用其他模型的配置写法

如果你的 OpenAI 账号支持其他模型，并且 WorkBuddy 当前版本可以通过 Chat Completions 调用该模型，可以把 id 改成你实际可用的模型 ID。下面用 YOUR_MODEL_ID 做占位，发布到自己的配置前要替换成 OpenAI 模型页和账号后台实际可见的模型名：

json

{
  "models": [
    {
      "id": "YOUR_MODEL_ID",
      "name": "ChatGPT API - Custom Model",
      "vendor": "OpenAI",
      "apiKey": "${OPENAI_API_KEY}",
      "url": "https://api.openai.com/v1/chat/completions",
      "maxInputTokens": 128000,
      "maxOutputTokens": 8192,
      "temperature": 0.3,
      "supportsToolCall": true,
      "supportsImages": true,
      "supportsReasoning": true
    }
  ],
  "availableModels": ["YOUR_MODEL_ID"]
}

如果报 model_not_found、unsupported model 或 invalid_request_error，不要先怀疑 WorkBuddy，先回到 OpenAI 模型页确认这个模型是否对你的账号开放，以及是否支持你正在使用的接口路径。

第五步：通过代理或中转 API 接入

如果你所在网络无法直连 api.openai.com，但你有自己的 OpenAI 兼容中转服务，也可以把 URL 改成你的中转接口。关键是路径必须是完整的 /chat/completions。

例如：

json

{
  "models": [
    {
      "id": "gpt-4o",
      "name": "ChatGPT API - Proxy",
      "vendor": "OpenAI",
      "apiKey": "${OPENAI_API_KEY}",
      "url": "https://your-proxy.example.com/v1/chat/completions",
      "maxInputTokens": 128000,
      "maxOutputTokens": 4096,
      "supportsToolCall": true,
      "supportsImages": true
    }
  ],
  "availableModels": ["gpt-4o"]
}

这里有两个常见坑：

不要只写 https://your-proxy.example.com/v1。WorkBuddy 文档要求 URL 通常要到 /chat/completions。
中转服务必须兼容 OpenAI Chat Completions 请求体。如果你的中转只支持 Responses API，WorkBuddy 的 models.json 方式可能无法直接使用。

第六步：在 WorkBuddy 里测试

配置完成后，打开 WorkBuddy 新建一次对话，输入下面的测试提示词：

text

请用三句话介绍你当前使用的模型，并说明是否支持代码生成。

如果响应正常，再测试代码能力：

text

请写一个 Node.js 函数，把数组里的重复字符串去掉，并给出一个调用示例。

如果你开启了图片输入能力，还可以上传一张截图，让模型描述界面内容。但只有模型、接口、WorkBuddy 版本都支持视觉输入时，这一步才会成功。

常见报错与解决方法

1. 模型列表里看不到 ChatGPT API

优先检查 availableModels 是否包含你的模型 ID：

json

{
  "availableModels": ["gpt-4o"]
}

如果你写的是项目级 .codebuddy/models.json，再确认当前 WorkBuddy 打开的项目目录是不是这个项目。

2. API Key 无效

典型错误是 401 Unauthorized 或 invalid_api_key。处理方法：

确认 API Key 没有复制少字符。
确认环境变量已经在启动 WorkBuddy 前生效。
如果你用的是环境变量引用 ${OPENAI_API_KEY}，不要在 JSON 里写成 $OPENAI_API_KEY。
重新生成一个 OpenAI API Key 后再试。

3. 接口地址错误

如果你填的是：

text

https://api.openai.com/v1

请改成：

text

https://api.openai.com/v1/chat/completions

WorkBuddy / CodeBuddy 的 models.json 文档明确说明，当前只支持 OpenAI 接口格式，url 字段必须是完整接口路径，通常以 /chat/completions 结尾。

4. 模型不存在或账号不可用

如果报 model_not_found，通常有 3 种原因：

模型 ID 写错。
你的 OpenAI 项目或账号没有这个模型权限。
该模型不支持你当前使用的接口路径。

解决办法是先用 curl 直接请求同一个模型。如果 curl 也失败，问题就在 OpenAI 账号、模型权限或接口路径，不在 WorkBuddy。

5. 响应很慢或经常超时

可以从 4 个方向排查：

先换更轻量的模型。
降低单次输入长度。
确认网络到 api.openai.com 或代理服务稳定。
如果是项目级配置，检查是否把所有子任务都绑定到了同一个大模型。

WorkBuddy 的 models.json 支持 relatedModels，可以给轻量任务、推理任务配置不同模型。对于频繁调用的团队项目，这样能明显降低成本和等待时间。

安全建议：不要把 Key 写进仓库

接入 ChatGPT API 时，最容易出问题的不是模型配置，而是 API Key 泄露。建议遵守下面几条：

使用 ${OPENAI_API_KEY} 引用环境变量。
不要把真实 Key 写进 .codebuddy/models.json 后提交到 Git。
如果是项目级配置，把真实 Key 放在个人环境变量或本地忽略文件里。
macOS 可以把 Key 放进 Keychain，再由 shell 启动时导出。
发现 Key 泄露后，立即在 OpenAI Platform 删除旧 Key 并创建新 Key。

FAQ

WorkBuddy 接入的是 ChatGPT 还是 OpenAI API？

严格说接入的是 OpenAI API。很多用户习惯把 OpenAI 的对话模型叫做 ChatGPT API，但在配置层面，你需要填写的是 OpenAI API Key、OpenAI 兼容接口地址和模型 ID。

WorkBuddy 可以直接填 Responses API 地址吗？

不建议。OpenAI 官方新项目更推荐 Responses API，但 WorkBuddy 当前 models.json 文档要求 OpenAI 接口格式，并强调 URL 通常以 /chat/completions 结尾。除非 WorkBuddy 后续版本明确支持 Responses API，否则接入 ChatGPT API 时应优先使用 Chat Completions 兼容地址。

为什么官方推荐模型和旧教程里的模型不一样？

OpenAI 模型更新很快，模型名称、上下文窗口、价格和接口支持范围都会变化。写配置前应以 OpenAI 官方 Models 页面和你账号后台实际可见模型为准。

国内网络无法访问 api.openai.com 怎么办？

可以使用你自己可信的 OpenAI 兼容代理或中转服务，把 url 改成中转服务的完整 /v1/chat/completions 地址。不要使用来源不明的公共 Key 或公共中转，避免代码、业务数据和 API Key 泄露。

总结

WorkBuddy 接入 ChatGPT API 的关键不是复杂代码，而是 3 个字段填对：apiKey、url、model id。新版用户优先用「设置 -> 模型」添加 OpenAI 或 Custom API；需要团队化管理时，再使用 ~/.codebuddy/models.json 或项目级 .codebuddy/models.json。配置前先用 curl 验证 OpenAI API，配置后再在 WorkBuddy 中切换模型测试，这样排错最快。

workbuddy 如何接入 chatgpt api ​

先看结论：WorkBuddy 接入 ChatGPT API 要填什么 ​

第一步：准备 OpenAI API Key ​

第二步：确认你的 ChatGPT API 能正常调用 ​

第三步：用 WorkBuddy 图形界面接入 ChatGPT API ​

第四步：用 models.json 接入 ChatGPT API ​

最小可用配置 ​

使用其他模型的配置写法 ​

第五步：通过代理或中转 API 接入 ​

第六步：在 WorkBuddy 里测试 ​

常见报错与解决方法 ​

1. 模型列表里看不到 ChatGPT API ​

2. API Key 无效 ​

3. 接口地址错误 ​

4. 模型不存在或账号不可用 ​

5. 响应很慢或经常超时 ​

安全建议：不要把 Key 写进仓库 ​

推荐配置方案 ​

FAQ ​

WorkBuddy 接入的是 ChatGPT 还是 OpenAI API？ ​

WorkBuddy 可以直接填 Responses API 地址吗？ ​

为什么官方推荐模型和旧教程里的模型不一样？ ​

国内网络无法访问 api.openai.com 怎么办？ ​

总结 ​

workbuddy 如何接入 chatgpt api

先看结论：WorkBuddy 接入 ChatGPT API 要填什么

第一步：准备 OpenAI API Key

第二步：确认你的 ChatGPT API 能正常调用

第三步：用 WorkBuddy 图形界面接入 ChatGPT API

第四步：用 models.json 接入 ChatGPT API

最小可用配置

使用其他模型的配置写法

第五步：通过代理或中转 API 接入

第六步：在 WorkBuddy 里测试

常见报错与解决方法

1. 模型列表里看不到 ChatGPT API

2. API Key 无效

3. 接口地址错误

4. 模型不存在或账号不可用

5. 响应很慢或经常超时

安全建议：不要把 Key 写进仓库

推荐配置方案

FAQ

WorkBuddy 接入的是 ChatGPT 还是 OpenAI API？

WorkBuddy 可以直接填 Responses API 地址吗？

为什么官方推荐模型和旧教程里的模型不一样？

国内网络无法访问 api.openai.com 怎么办？

总结