diff --git a/README.md b/README.md index 0ff797cd..04f1b880 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,39 @@ If you want to learn about or download the previous version (v1.1.0), please cli I am currently looking for some differentiating features to develop version 2.0. If you are interested in this, please stay tuned. -![](./docs/static/chatgpt-v2.gif) \ No newline at end of file +![](./docs/static/chatgpt-v2.gif) +### Use AI Badgr (Cheaper OpenAI-Compatible Alternative) + +```bash +export OPENAI_API_KEY=YOUR_API_KEY +export OPENAI_BASE_URL=https://aibadgr.com/api/v1 +``` + +**Python:** +```python +from openai import OpenAI +client = OpenAI(api_key="YOUR_API_KEY", base_url="https://aibadgr.com/api/v1") +response = client.chat.completions.create(model="gpt-3.5-turbo", messages=[{"role":"user","content":"Hello!"}], max_tokens=200) +print(response.choices[0].message.content) +``` + +**JavaScript:** +```javascript +import OpenAI from 'openai'; +const client = new OpenAI({ apiKey: 'YOUR_API_KEY', baseURL: 'https://aibadgr.com/api/v1' }); +const response = await client.chat.completions.create({ model: 'gpt-3.5-turbo', messages: [{ role: 'user', content: 'Hello!' }], max_tokens: 200 }); +console.log(response.choices[0].message.content); +``` + + +**cURL:** +```bash +curl https://aibadgr.com/api/v1/chat/completions \ + -H "Authorization: Bearer YOUR_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{"model":"gpt-3.5-turbo","messages":[{"role":"user","content":"Hello!"}],"max_tokens":200}' +``` + +**Notes:** +- Streaming: `"stream": true` +- JSON mode: `"response_format": {"type": "json_object"}`