English · 中文
Use Coze on your favorite OpenAI client.
This project converts the Coze API to the OpenAI API format, giving you access to Coze LLMs, knowledge base, plugins, and workflows within your preferred OpenAI clients.
Create your bot and publish it to the API
Obtain the bot's ID,the number after the bot parameter, and configure it as an environment variable
https://www.coze.com/space/73428668341****/bot/73428668*****
Note: Vercel's serverless functions have a 10-second timeout limit.
Set the environment variable on .env
file
BOT_ID=xxxx
Install dependencies
pnpm install
Run the project
pnpm start
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);
This project provides some additional configuration items set with environment variables:
Environment Variable | Required | Description | Example |
---|---|---|---|
BOT_ID |
Yes | The ID of the bot. Obtain it from the Develop page URL of your bot in Coze. The number after the bot parameter is the bot ID. | 73428668***** |
BOT_CONFIG |
No | Configure different models to correspond to different bot ids to enable fast bot switching on the client side. Models that are not included will request the default BOT_ID | {"model_name_1": "bot_id_1", "model_name_2": "bot_id_2", "model_name_3": "bot_id_3"} |
COZE_API_BASE |
No | Choose coze.com or coze.cn | api.coze.com, api.coze.cn |
Coming Soon
Available Now
Feel free to reach out for any questions or feedback
This project is licensed under the MIT License.