Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fatwang2/coze2openai
Turn Coze API into OpenAI
https://github.com/fatwang2/coze2openai
Last synced: 2 months ago
JSON representation
Turn Coze API into OpenAI
- Host: GitHub
- URL: https://github.com/fatwang2/coze2openai
- Owner: fatwang2
- License: mit
- Created: 2024-04-15T15:54:50.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-04-16T15:51:47.000Z (2 months ago)
- Last Synced: 2024-04-16T22:18:43.284Z (2 months ago)
- Language: JavaScript
- Homepage: https://coze2openai.vercel.app
- Size: 647 KB
- Stars: 146
- Watchers: 2
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-stars - fatwang2/coze2openai - Turn Coze API into OpenAI (JavaScript)
- awesome-stars - fatwang2/coze2openai - Turn Coze API into OpenAI (JavaScript)
README
## C2O
**Use Coze on your favorite OpenAI client.**
This project converts the Coze API to the OpenAI API format, giving you access to Coze's LLMs, knowledge base, plugins, and workflows within your preferred OpenAI clients.
## Features
- Convert Coze API into an OpenAI API
- Support streaming and blocking
- Support Chatbots API on Coze
## Preparation
1. Register with Coze and obtain your API token
2. Create your bot and publish it to the API
3. Obtain the bot's ID,the number after the bot parameter, and configure it as an environment variable
```bash
https://www.coze.com/space/73428668341****/bot/73428668*****
```
## Deployment
### Zeabur
[](https://zeabur.com/templates/BZ515Z?referralCode=fatwang2)
### Vercel
[](https://vercel.com/new/clone?repository-url=https://github.com/fatwang2/coze2openai&env=BOT_ID&envDescription=COZE_BOT_ID)
**Note:** Vercel's serverless functions have a 10-second timeout limit.
### Local Deployment
1. Set the environment variable on `.env` file
```bash
BOT_ID=xxxx
```
2. Install dependencies
```bash
pnpm install
```
3. Run the project
```bash
pnpm start
```
## Usage
```JavaScript
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: 'Coze',
messages: [
{ role: 'system', content: 'You are a helpful assistant.' },
{ role: 'user', content: 'Hello, how are you?' },
],
}),
});
const data = await response.json();
console.log(data);
```
## Environment Variable
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*****`|
## Roadmap
**Coming Soon**
* Image support
* Audio-to-text
* Text-to-audio
* Docker support
* Workflow Bot
* Variables support
**Available Now**
* Continuous dialogue
* Zeabur & Vercel deployment
* Streaming & Blocking
* Plugins on Coze
## Contact
Feel free to reach out for any questions or feedback
[X](https://sum4all.site/twitter)\
[telegram](https://sum4all.site/telegram)
## License
This project is licensed under the MIT License.