coze2openai API 参考手册/v1/chat/completions 接口字段与调用实例详解【免费下载链接】coze2openaiTurn Coze API into OpenAI项目地址: https://gitcode.com/gh_mirrors/co/coze2openaicoze2openai 是一个将 Coze API 转换为 OpenAI API 格式的开源代理项目让你能在任意 OpenAI 兼容客户端中直接调用 Coze 的大模型、知识库、插件与工作流。本手册围绕其核心端点/v1/chat/completions接口逐字段拆解请求与响应格式并通过非流式、流式、多机器人切换等调用实例帮助你快速完成对接。全文基于 app.js 源码实测整理可直接照抄运行。coze2openai 是什么一句话看懂核心能力简单来说coze2openai 就是一个翻译层它接收 OpenAI 格式的请求转发给 Coze 的/open_api/v2/chat接口再把结果还原成 OpenAI 格式返回。它的三个核心能力是格式转换Coze API 无缝变身为 OpenAI Chat Completions API⚡流式 非流式同时支持 SSE 流式输出与一次性返回多机器人切换通过请求中的model字段快速切换不同的 Coze Bot调用前准备获取 Coze API Token 与 Bot ID调用/v1/chat/completions接口前你只需要准备两样东西Coze API Token和Bot ID。第一步注册并生成 API Token在 Coze 控制台的 API Tokens 页面点击 Add new token复制生成的令牌。这个令牌将作为请求头Authorization: Bearer token使用也是 OpenAI 客户端中的 API Key第二步创建 Bot 并发布到 API在 Bot 的 Publish 页面选择 Bot as API 并完成发布发布状态显示 Authorized 即表示成功第三步找到 Bot IDBot 开发页面 URL 中bot/后面的那一串数字就是 Bot ID例如https://www.coze.com/space/xxx/bot/73428668*****中的73428668*****。快速部署3 个环境变量启动本地服务克隆仓库后只需配置环境变量即可启动git clone https://gitcode.com/gh_mirrors/co/coze2openai cd coze2openai pnpm install pnpm start服务默认监听3000端口环境变量说明如下环境变量必填作用示例BOT_ID✅默认 Bot ID所有未配置的模型请求都走它73428668*****BOT_CONFIG❌模型与 Bot ID 的映射表实现多机器人切换{gpt-4o: bot_id_1}COZE_API_BASE❌选择 Coze 国际版或国内版api.coze.com/api.coze.cn 国内用户记得把COZE_API_BASE设为api.coze.cn否则会请求失败。/v1/chat/completions 接口请求字段详解接口地址为POST /v1/chat/completions与 OpenAI 官方接口完全一致。请求体支持以下字段字段类型必填说明messagesarray✅消息列表最后一条作为本轮提问前面的消息自动作为对话历史modelstring✅模型名用于映射到对应的 Bot ID见多机器人切换章节streamboolean❌是否流式输出默认falseuserstring❌用户标识默认apiuser请求头需要携带Authorization: Bearer 你的 Coze API Token否则会返回401 Unauthorized。⚠️ 注意temperature、max_tokens等 OpenAI 参数目前不会被透传会被忽略这是源码实现中的已知特性。非流式调用实例字段与返回结构对照先看一个最基础的调用实例blocking 模式curl http://localhost:3000/v1/chat/completions \ -H Content-Type: application/json \ -H Authorization: Bearer YOUR_COZE_API_KEY \ -d { model: model_name, messages: [ { role: system, content: You are a helpful assistant. }, { role: user, content: 你好介绍一下自己 } ] }返回结果与 OpenAI 格式几乎一致{ id: chatcmpl-1721xxxx, object: chat.completion, created: 1721360000, model: model_name, choices: [ { index: 0, message: { role: assistant, content: 你好我是由 Coze 驱动的助手…… }, logprobs: null, finish_reason: stop } ], usage: { prompt_tokens: 100, completion_tokens: 10, total_tokens: 110 }, system_fingerprint: fp_2f57f81c11 }各字段含义id为每次请求生成的唯一编号created为 Unix 时间戳choices[0].message.content就是 Bot 的回答内容usage为 token 用量统计当前为占位数值。流式输出实例SSE 数据格式详解把请求中的stream设为true即可开启流式输出。服务端会以text/event-stream格式逐段推送内容curl -N http://localhost:3000/v1/chat/completions \ -H Content-Type: application/json \ -H Authorization: Bearer YOUR_COZE_API_KEY \ -d { model: model_name, stream: true, messages: [ { role: user, content: 讲个笑话 } ] }返回的每个数据块形如data: {id:chatcmpl-1721xxxx,object:chat.completion.chunk, choices:[{index:0,delta:{content:哈},finish_reason:null}]} data: {id:chatcmpl-1721xxxx,object:chat.completion.chunk, choices:[{index:0,delta:{content:哈},finish_reason:null}]} data: {id:chatcmpl-1721xxxx,object:chat.completion.chunk, choices:[{index:0,delta:{},finish_reason:stop}]} data: [DONE]流式输出的关键点object为chat.completion.chunk内容增量在choices[0].delta.content中结尾以finish_reason: stop收尾并输出data: [DONE]标记结束。Coze 侧发生错误时服务端也会以 SSE 形式推送错误信息。多机器人切换用 model 字段映射不同 Bot如果你配置了多个 Bot可以设置BOT_CONFIG环境变量建立模型名 → Bot ID的映射BOT_CONFIG{gpt-4o: bot_id_1, gpt-4-turbo: bot_id_2}之后在 OpenAI 客户端里选择模型gpt-4o请求就会自动转发给bot_id_1对应的 Bot选择未在映射表中的模型时则回落到默认的BOT_ID。这个机制由 app.js 中的一行代码实现非常巧妙。在 OpenAI 客户端中配置使用部署完成后把任意 OpenAI 兼容客户端的接口地址指向http://localhost:3000/v1API Key 填你的 Coze Token 即可配置完成后就能在客户端中直接与 Coze Bot 对话享受知识库、插件和工作流带来的增强能力。项目完整的调用示例还可以参考 README.md 与 README_CN.md。常见报错与排查建议错误现象可能原因解决方法401 Unauthorized请求头缺少或未正确携带 Token检查Authorization: Bearer token格式请求超时部署在 Vercel有 10 秒限制且对话较长改用本地部署、Zeabur 或 Railway返回 Coze 错误信息Token 无效、Bot 未发布到 API重新生成 Token确认 Bot as API 已发布请求api.coze.cn失败环境变量未配置设置COZE_API_BASEapi.coze.cn总结coze2openai 用最轻量的方式打通了 Coze 与 OpenAI 生态一个/v1/chat/completions端点就同时支持了格式转换、流式输出和多机器人切换。看完本手册你应该已经掌握了它的请求字段、响应结构、流式数据格式与常见坑位。接下来不妨动手部署一个把 Coze 的能力接入你最喜欢的 OpenAI 客户端吧【免费下载链接】coze2openaiTurn Coze API into OpenAI项目地址: https://gitcode.com/gh_mirrors/co/coze2openai创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
