C2O

English · 中文

在您喜爱的 OpenAI 客户端上使用 Coze。

本项目将 Coze API 转换为 OpenAI API 格式，让您能够在首选的 OpenAI 客户端中访问 Coze 的大模型、知识库、插件和工作流。

特性

• 将 Coze API 转换为 OpenAI API
• 支持流式传输和阻塞模式
• 支持多机器人切换

准备工作

1. 在 coze.com 或 coze.cn 注册并获取您的 API 令牌

2. 创建您的机器人并将其发布到 API

3. 获取机器人的 ID，即 bot 参数后面的数字，并将其配置为环境变量：

https://www.coze.com/space/73428668341****/bot/73428668*****

部署方式

Zeabur

Vercel

注意： Vercel 的无服务器函数有 10 秒的超时限制。

Railway

Docker 部署

1. 确保您的机器上已安装 Docker 和 Docker Compose。

2. 克隆项目仓库：

   git clone https://github.com/your-username/coze2openai.git
   cd coze2openai
   

3. 创建并配置 .env 文件：

   cp .env.template .env
   

   编辑 .env 文件，填写您的 BOT_ID 及其他必要配置。

4. 构建并启动 Docker 容器：

   docker-compose up -d
   

5. 访问 http://localhost:3000，确认服务正常运行。

要停止服务，请运行：

docker-compose down

注意：Dockerfile 使用了淘宝 NPM 镜像，您可以注释掉或替换为其他镜像：

ENV NPM_CONFIG_REGISTRY=https://registry.npmmirror.com/
ENV PNPM_REGISTRY=https://registry.npmmirror.com/

本地部署

1. 在 .env 文件中设置环境变量：

BOT_ID=xxxx

2. 安装依赖：

pnpm install

3. 运行项目：

pnpm start

使用方法

1. OpenAI 客户端

2. 代码示例：

const response = await fetch('http://localhost:3000/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_COZE_API_KEY',
  },
  body: JSON.stringify({
    model: 'model_name',
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: 'Hello, how are you?' },
    ],
  }),
});

const data = await response.json();
console.log(data);

环境变量

本项目提供了一些通过环境变量设置的额外配置项：

环境变量	是否必填	描述	示例
BOT_ID	是	机器人的 ID。从 Coze 中您机器人的开发页面 URL 获取。bot 参数后面的数字即为机器人 ID。	73428668*****
BOT_CONFIG	否	配置不同模型对应的机器人 ID，以便在客户端快速切换机器人。未包含的模型将请求默认的 BOT_ID	{"model_name_1": "bot_id_1", "model_name_2": "bot_id_2", "model_name_3": "bot_id_3"}
COZE_API_BASE	否	选择 coze.com 或 coze.cn	api.coze.com, api.coze.cn

路线图

即将推出

• 图像支持
• 音频转文本
• 文本转音频

现已可用

• Coze.cn 支持
• 多机器人切换
• 工作流、插件、知识库功能
• 基于聊天历史的连续对话
• Zeabur、Vercel 和 Railway 部署
• 流式传输与阻塞模式
• Docker 部署

联系方式

如有任何问题或反馈，欢迎随时联系。

X
telegram

许可证

本项目采用 MIT 许可证授权。

coze2openai 快速上手指南

coze2openai 是一个将 Coze API 转换为 OpenAI API 格式的开源工具，让你能在任意支持 OpenAI 协议的客户端（如 Chatbox、NextChat 等）或代码中直接使用 Coze 的机器人、知识库、插件和工作流。

环境准备

• 系统要求：支持 Docker 的环境，或安装了 Node.js (推荐 v18+) 的操作系统。
• 前置依赖：
  • 已注册 Coze (扣子) 账号。
  • 已创建并发布一个 Bot 到 API。
  • 获取 API Token 和 Bot ID：
    1. 在 Coze 开发页面获取 API Token。
    2. 从浏览器地址栏获取 Bot ID（URL 中 bot/ 后面的数字，例如 .../bot/73428668*****）。

安装步骤

你可以选择 Docker 部署（推荐，配置简单且自动使用国内镜像源）或 本地源码部署。

方案一：Docker 部署（推荐）

1. 克隆项目并进入目录：

   git clone https://github.com/fatwang2/coze2openai.git
   cd coze2openai
   

2. 复制环境变量模板并编辑配置：

   cp .env.template .env
   

   使用编辑器打开 .env 文件，填入你的 Bot ID：

   BOT_ID=你的 Bot_ID_数字
   # 如果使用的是国内版扣子，建议添加以下配置
   COZE_API_BASE=api.coze.cn
   

3. 启动服务：

   docker-compose up -d
   

   注：Dockerfile 默认已配置淘宝 NPM 镜像源 (registry.npmmirror.com)，国内下载依赖更快。

4. 验证服务：访问 http://localhost:3000 确认服务运行正常。

方案二：本地源码部署

1. 克隆项目并进入目录：

   git clone https://github.com/fatwang2/coze2openai.git
   cd coze2openai
   

2. 配置环境变量：

   cp .env.template .env
   # 编辑 .env 文件，设置 BOT_ID 和 COZE_API_BASE
   

3. 安装依赖（推荐使用 pnpm）：

   pnpm install
   

4. 启动项目：

   pnpm start
   

基本使用

部署完成后，该服务会暴露一个兼容 OpenAI 格式的接口 http://localhost:3000/v1/chat/completions。

1. 在第三方客户端中使用

配置你的 AI 客户端（如 Chatbox, Lore, NextChat 等）：

• API 地址 (Base URL): http://localhost:3000/v1 (本地部署) 或你的服务器地址。
• API 密钥 (API Key): 填写你在 Coze 获取的 API Token。
• 模型名称 (Model): 填写任意字符串（若未配置多 Bot 映射，将默认使用环境变量中的 BOT_ID），或根据 BOT_CONFIG 配置特定的模型名来切换 Bot。

2. 代码调用示例

以下是一个标准的 JavaScript 调用示例：

const response = await fetch('http://localhost:3000/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_COZE_API_KEY', // 替换为你的 Coze API Token
  },
  body: JSON.stringify({
    model: 'model_name', // 可随意填写，或通过 BOT_CONFIG 映射特定 Bot
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: 'Hello, how are you?' },
    ],
  }),
});

const data = await response.json();
console.log(data);

高级配置：多 Bot 切换

如需在客户端通过切换“模型名”来调用不同的 Coze Bot，可在 .env 中配置 BOT_CONFIG：

BOT_CONFIG={"my_bot_1": "Bot_ID_1", "my_bot_2": "Bot_ID_2"}

配置后，在客户端选择模型 my_bot_1 即可自动路由到对应的 Bot。