kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
378 wiersze
17 KiB
Markdown
378 wiersze
17 KiB
Markdown
chatgpt / [Exports](modules.md)
|
||
|
||
# Update December 18, 2022 <!-- omit in toc -->
|
||
|
||
On December 11th, OpenAI added Cloudflare protections that make it more difficult to access the unofficial API.
|
||
|
||
To circumvent these protections, we've added a **fully automated browser-based solution**, which uses Puppeteer and CAPTCHA solvers under the hood. 🔥
|
||
|
||
```ts
|
||
import { ChatGPTAPIBrowser } from 'chatgpt'
|
||
|
||
const api = new ChatGPTAPIBrowser({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD
|
||
})
|
||
await api.initSession()
|
||
|
||
const result = await api.sendMessage('Hello World!')
|
||
console.log(result.response)
|
||
```
|
||
|
||
This solution is not lightweight, but it does work a lot more consistently than the previous REST API-based approach. For example, I'm currently using this approach to automate 10 concurrent OpenAI accounts for my [Twitter bot](https://github.com/transitive-bullshit/chatgpt-twitter-bot). 😂
|
||
|
||
To use the updated version, **make sure you're using the latest version of this package and Node.js >= 18**. Then update your code following the examples below, paying special attention to the sections on [Authentication](#authentication), [Restrictions](#restrictions), and [CAPTCHAs](#captchas).
|
||
|
||
We recently added support for CAPTCHA automation using either [nopecha](https://nopecha.com/) or [2captcha](https://2captcha.com). Keep in mind that this package will be updated to use the official API as soon as it's released, so things should get much easier over time. 💪
|
||
|
||
Lastly, please consider starring this repo and <a href="https://twitter.com/transitive_bs">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a> to help support the project.
|
||
|
||
Thanks && cheers,
|
||
[Travis](https://twitter.com/transitive_bs)
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<img alt="Example usage" src="/media/demo.gif">
|
||
</p>
|
||
|
||
# ChatGPT API <!-- omit in toc -->
|
||
|
||
> Node.js client for the unofficial [ChatGPT](https://openai.com/blog/chatgpt/) API.
|
||
|
||
[](https://www.npmjs.com/package/chatgpt) [](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml) [](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license) [](https://prettier.io)
|
||
|
||
- [Intro](#intro)
|
||
- [Install](#install)
|
||
- [Usage](#usage)
|
||
- [Docs](#docs)
|
||
- [Demos](#demos)
|
||
- [Authentication](#authentication)
|
||
- [CAPTCHAs](#captchas)
|
||
- [Using Proxies](#using-proxies)
|
||
- [Restrictions](#restrictions)
|
||
- [Projects](#projects)
|
||
- [Compatibility](#compatibility)
|
||
- [Credits](#credits)
|
||
- [License](#license)
|
||
|
||
## Intro
|
||
|
||
This package is a Node.js wrapper around [ChatGPT](https://openai.com/blog/chatgpt) by [OpenAI](https://openai.com). TS batteries included. ✨
|
||
|
||
You can use it to start building projects powered by ChatGPT like chatbots, websites, etc...
|
||
|
||
## Install
|
||
|
||
```bash
|
||
npm install chatgpt puppeteer
|
||
```
|
||
|
||
`puppeteer` is an optional peer dependency used to automate bypassing the Cloudflare protections via `getOpenAIAuth`. The main API wrapper uses `fetch` directly.
|
||
|
||
## Usage
|
||
|
||
```ts
|
||
import { ChatGPTAPIBrowser } from 'chatgpt'
|
||
|
||
async function example() {
|
||
// use puppeteer to bypass cloudflare (headful because of captchas)
|
||
const api = new ChatGPTAPIBrowser({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD
|
||
})
|
||
|
||
await api.initSession()
|
||
|
||
const result = await api.sendMessage('Hello World!')
|
||
console.log(result.response)
|
||
}
|
||
```
|
||
|
||
<details>
|
||
<summary>Or, if you want to use the REST-based version:</summary>
|
||
|
||
```ts
|
||
import { ChatGPTAPI, getOpenAIAuth } from 'chatgpt'
|
||
|
||
async function example() {
|
||
// use puppeteer to bypass cloudflare (headful because of captchas)
|
||
const openAIAuth = await getOpenAIAuth({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD
|
||
})
|
||
|
||
const api = new ChatGPTAPI({ ...openAIAuth })
|
||
await api.initSession()
|
||
|
||
// send a message and wait for the response
|
||
const result = await api.sendMessage('Write a python version of bubble sort.')
|
||
|
||
// result.response is a markdown-formatted string
|
||
console.log(result.response)
|
||
}
|
||
```
|
||
|
||
</details>
|
||
|
||
ChatGPT responses are formatted as markdown by default. If you want to work with plaintext instead, you can use:
|
||
|
||
```ts
|
||
const api = new ChatGPTAPIBrowser({ email, password, markdown: false })
|
||
```
|
||
|
||
If you want to track the conversation, use the `conversationId` and `messageId` in the result object, and pass them to `sendMessage` as `conversationId` and `parentMessageId` respectively.
|
||
|
||
```ts
|
||
const api = new ChatGPTAPIBrowser({ email, password })
|
||
await api.initSession()
|
||
|
||
// send a message and wait for the response
|
||
let res = await api.sendMessage('What is OpenAI?')
|
||
console.log(res.response)
|
||
|
||
// send a follow-up
|
||
res = await api.sendMessage('Can you expand on that?', {
|
||
conversationId: res.conversationId,
|
||
parentMessageId: res.messageId
|
||
})
|
||
console.log(res.response)
|
||
|
||
// send another follow-up
|
||
// send a follow-up
|
||
res = await api.sendMessage('What were we talking about?', {
|
||
conversationId: res.conversationId,
|
||
parentMessageId: res.messageId
|
||
})
|
||
console.log(res.response)
|
||
```
|
||
|
||
Sometimes, ChatGPT will hang for an extended period of time before beginning to respond. This may be due to rate limiting or it may be due to OpenAI's servers being overloaded.
|
||
|
||
To mitigate these issues, you can add a timeout like this:
|
||
|
||
```ts
|
||
// timeout after 2 minutes (which will also abort the underlying HTTP request)
|
||
const response = await api.sendMessage('this is a timeout test', {
|
||
timeoutMs: 2 * 60 * 1000
|
||
})
|
||
```
|
||
|
||
<details>
|
||
<summary>Usage in CommonJS (Dynamic import)</summary>
|
||
|
||
```js
|
||
async function example() {
|
||
// To use ESM in CommonJS, you can use a dynamic import
|
||
const { ChatGPTAPI, getOpenAIAuth } = await import('chatgpt')
|
||
|
||
const openAIAuth = await getOpenAIAuth({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD
|
||
})
|
||
|
||
const api = new ChatGPTAPI({ ...openAIAuth })
|
||
await api.initSession()
|
||
|
||
const result = await api.sendMessage('Hello World!')
|
||
console.log(result)
|
||
}
|
||
```
|
||
|
||
</details>
|
||
|
||
### Docs
|
||
|
||
See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters. Here are the [docs](./docs/classes/ChatGPTAPIBrowser.md) for the browser-based version.
|
||
|
||
### Demos
|
||
|
||
To run the included demos:
|
||
|
||
1. clone repo
|
||
2. install node deps
|
||
3. set `OPENAI_EMAIL` and `OPENAI_PASSWORD` in .env
|
||
|
||
A [basic demo](./demos/demo.ts) is included for testing purposes:
|
||
|
||
```bash
|
||
npx tsx demos/demo.ts
|
||
```
|
||
|
||
A [conversation demo](./demos/demo-conversation.ts) is also included:
|
||
|
||
```bash
|
||
npx tsx demos/demo-conversation.ts
|
||
```
|
||
|
||
A [browser-based conversation demo](./demos/demo-conversation-browser.ts) is also included:
|
||
|
||
```bash
|
||
npx tsx demos/demo-conversation-browser.ts
|
||
```
|
||
|
||
### Authentication
|
||
|
||
The authentication section relates to the REST-based version (using `getOpenAIAuth` + `ChatGPTAPI`). The browser-based solution, `ChatGPTAPIBrowser`, takes care of all the authentication for you.
|
||
|
||
On December 11, 2022, OpenAI added some additional Cloudflare protections which make it more difficult to access the unofficial API.
|
||
|
||
You'll need a valid OpenAI "session token" and Cloudflare "clearance token" in order to use the API.
|
||
|
||
We've provided an automated, Puppeteer-based solution `getOpenAIAuth` to fetch these for you, but you may still run into cases where you have to manually pass the CAPTCHA. We're working on a solution to automate this further.
|
||
|
||
You can also get these tokens manually, but keep in mind that the `clearanceToken` only lasts for max 2 hours.
|
||
|
||
<details>
|
||
<summary>Getting tokens manually</summary>
|
||
|
||
To get session token manually:
|
||
|
||
1. Go to https://chat.openai.com/chat and log in or sign up.
|
||
2. Open dev tools.
|
||
3. Open `Application` > `Cookies`.
|
||
|
||
4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. This will be your `sessionToken`.
|
||
5. Copy the value for `cf_clearance` and save it to your environment. This will be your `clearanceToken`.
|
||
6. Copy the value of the `user-agent` header from any request in your `Network` tab. This will be your `userAgent`.
|
||
|
||
Pass `sessionToken`, `clearanceToken`, and `userAgent` to the `ChatGPTAPI` constructor.
|
||
|
||
</details>
|
||
|
||
> **Note**
|
||
> This package will switch to using the official API once it's released, which will make this process much simpler.
|
||
|
||
### CAPTCHAs
|
||
|
||
The browser portions of this package use Puppeteer to automate as much as possible, including solving all CAPTCHAs. 🔥
|
||
|
||
Basic Cloudflare CAPTCHAs are handled by default, but if you want to automate the email + password Recaptchas, you'll need to sign up for one of these paid providers:
|
||
|
||
- [nopecha](https://nopecha.com/) - Uses AI to solve CAPTCHAS
|
||
- Faster and cheaper
|
||
- Set the `NOPECHA_KEY` env var to your nopecha API key
|
||
- [Demo video](https://user-images.githubusercontent.com/552829/208235991-de4890f2-e7ba-4b42-bf55-4fcd792d4b19.mp4) of nopecha solving the login Recaptcha (41 seconds)
|
||
- [2captcha](https://2captcha.com) - Uses real people to solve CAPTCHAS
|
||
- More well-known solution that's been around longer
|
||
- Set the `CAPTCHA_TOKEN` env var to your 2captcha API token
|
||
|
||
Alternatively, if your OpenAI account uses Google Auth, you shouldn't encounter any of the more complicated Recaptchas — and can avoid using these third-party providers. To use Google auth, make sure your OpenAI account is using Google and then set `isGoogleLogin` to `true` whenever you're passing your `email` and `password`. For example:
|
||
|
||
```ts
|
||
const api = new ChatGPTAPIBrowser({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD,
|
||
isGoogleLogin: true
|
||
})
|
||
```
|
||
|
||
### Using Proxies
|
||
|
||
The browser implementation supports setting a proxy server. This is useful if you're running into rate limiting issues or if you want to use a proxy to hide your IP address.
|
||
|
||
To use a proxy, pass the `proxyServer` option to the `ChatGPTAPIBrowser` constructor, or simply set the `PROXY_SERVER` env var. For more information on the format, see [here](https://www.chromium.org/developers/design-documents/network-settings).
|
||
|
||
```ts
|
||
const api = new ChatGPTAPIBrowser({
|
||
email: process.env.OPENAI_EMAIL,
|
||
password: process.env.OPENAI_PASSWORD,
|
||
proxyServer: '<ip>:<port>'
|
||
})
|
||
```
|
||
|
||
You can also set the `PROXY_VALIDATE_IP` env var to your proxy's IP address. This will be used to validate that the proxy is working correctly, and will throw an error if it's not.
|
||
|
||
### Restrictions
|
||
|
||
These restrictions are for the `getOpenAIAuth` + `ChatGPTAPI` solution, which uses the unofficial API. The browser-based solution, `ChatGPTAPIBrowser`, generally doesn't have any of these restrictions.
|
||
|
||
**Please read carefully**
|
||
|
||
- You must use `node >= 18` at the moment. I'm using `v19.2.0` in my testing.
|
||
- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so.
|
||
- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`.
|
||
- This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere.
|
||
- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA.
|
||
- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session.
|
||
|
||
> **Note**
|
||
> Prior to v1.0.0, this package used a headless browser via [Playwright](https://playwright.dev/) to automate the web UI. Here are the [docs for the initial browser version](https://github.com/transitive-bullshit/chatgpt-api/tree/v0.4.2).
|
||
|
||
## Projects
|
||
|
||
All of these awesome projects are built using the `chatgpt` package. 🤯
|
||
|
||
- [Twitter Bot](https://github.com/transitive-bullshit/chatgpt-twitter-bot) powered by ChatGPT ✨
|
||
- Mention [@ChatGPTBot](https://twitter.com/ChatGPTBot) on Twitter with your prompt to try it out
|
||
- [Lovelines.xyz](https://lovelines.xyz?ref=chatgpt-api)
|
||
- [Chrome Extension](https://github.com/gragland/chatgpt-everywhere) ([demo](https://twitter.com/gabe_ragland/status/1599466486422470656))
|
||
- [VSCode Extension #1](https://github.com/mpociot/chatgpt-vscode) ([demo](https://twitter.com/marcelpociot/status/1599180144551526400), [updated version](https://github.com/timkmecl/chatgpt-vscode), [marketplace](https://marketplace.visualstudio.com/items?itemName=timkmecl.chatgpt))
|
||
- [VSCode Extension #2](https://github.com/barnesoir/chatgpt-vscode-plugin) ([marketplace](https://marketplace.visualstudio.com/items?itemName=JayBarnes.chatgpt-vscode-plugin))
|
||
- [VSCode Extension #3](https://github.com/gencay/vscode-chatgpt) ([marketplace](https://marketplace.visualstudio.com/items?itemName=gencay.vscode-chatgpt))
|
||
- [VSCode Extension #4](https://github.com/dogukanakkaya/chatgpt-code-vscode-extension) ([marketplace](https://marketplace.visualstudio.com/items?itemName=dogukanakkaya.chatgpt-code))
|
||
- [Raycast Extension #1](https://github.com/abielzulio/chatgpt-raycast) ([demo](https://twitter.com/abielzulio/status/1600176002042191875))
|
||
- [Raycast Extension #2](https://github.com/domnantas/raycast-chatgpt)
|
||
- [Telegram Bot #1](https://github.com/realies/chatgpt-telegram-bot)
|
||
- [Telegram Bot #2](https://github.com/dawangraoming/chatgpt-telegram-bot)
|
||
- [Deno Telegram Bot](https://github.com/Ciyou/chatbot-telegram)
|
||
- [Go Telegram Bot](https://github.com/m1guelpf/chatgpt-telegram)
|
||
- [GitHub ProBot](https://github.com/oceanlvr/ChatGPTBot)
|
||
- [Discord Bot #1](https://github.com/onury5506/Discord-ChatGPT-Bot)
|
||
- [Discord Bot #2](https://github.com/Nageld/ChatGPT-Bot)
|
||
- [Discord Bot #3](https://github.com/leinstay/gptbot)
|
||
- [Discord Bot #4 (selfbot)](https://github.com/0x7030676e31/cumsocket)
|
||
- [WeChat Bot #1](https://github.com/AutumnWhj/ChatGPT-wechat-bot)
|
||
- [WeChat Bot #2](https://github.com/fuergaosi233/wechat-chatgpt)
|
||
- [WeChat Bot #3](https://github.com/wangrongding/wechat-bot)
|
||
- [WeChat Bot #4](https://github.com/darknightlab/wechat-bot)
|
||
- [WeChat Bot #5](https://github.com/sunshanpeng/wechaty-chatgpt)
|
||
- [QQ Bot (plugin for Yunzai-bot)](https://github.com/ikechan8370/chatgpt-plugin)
|
||
- [QQ Bot (plugin for KiviBot)](https://github.com/KiviBotLab/kivibot-plugin-chatgpt)
|
||
- [QQ Bot (oicq)](https://github.com/easydu2002/chat_gpt_oicq)
|
||
- [QQ Bot (oicq + RabbitMQ)](https://github.com/linsyking/ChatGPT-QQBot)
|
||
- [QQ Bot (go-cqhttp)](https://github.com/PairZhu/ChatGPT-QQRobot)
|
||
- [EXM smart contracts](https://github.com/decentldotland/molecule)
|
||
- [Flutter ChatGPT API](https://github.com/coskuncay/flutter_chatgpt_api)
|
||
- [Carik Bot](https://github.com/luridarmawan/Carik)
|
||
- [Github Action for reviewing PRs](https://github.com/kxxt/chatgpt-action/)
|
||
- [WhatsApp Bot #1](https://github.com/pascalroget/whatsgpt) (multi-user support)
|
||
- [WhatsApp Bot #2](https://github.com/amosayomide05/chatgpt-whatsapp-bot)
|
||
- [WhatsApp Bot #3](https://github.com/navopw/whatsapp-chatgpt)
|
||
- [Matrix Bot](https://github.com/jakecoppinger/matrix-chatgpt-bot)
|
||
- [Rental Cover Letter Generator](https://sharehouse.app/ai)
|
||
- [Assistant CLI](https://github.com/diciaup/assistant-cli)
|
||
- [Teams Bot](https://github.com/formulahendry/chatgpt-teams-bot)
|
||
- [Askai](https://github.com/yudax42/askai)
|
||
- [TalkGPT](https://github.com/ShadovvBeast/TalkGPT)
|
||
- [iOS Shortcut](https://github.com/leecobaby/shortcuts/blob/master/other/ChatGPT_EN.md)
|
||
- [Slack Bot](https://github.com/trietphm/chatgpt-slackbot/)
|
||
- [Electron Bot](https://github.com/ShiranAbir/chaty)
|
||
- [Kodyfire CLI](https://github.com/nooqta/chatgpt-kodyfire)
|
||
- [Twitch Bot](https://github.com/BennyDeeDev/chatgpt-twitch-bot)
|
||
- [Continuous Conversation](https://github.com/DanielTerletzkiy/chat-gtp-assistant)
|
||
- [Figma plugin](https://github.com/frederickk/chatgpt-figma-plugin)
|
||
|
||
If you create a cool integration, feel free to open a PR and add it to the list.
|
||
|
||
## Compatibility
|
||
|
||
This package is ESM-only. It supports:
|
||
|
||
- Node.js >= 18
|
||
- Node.js 17, 16, and 14 were supported in earlier versions, but OpenAI's Cloudflare update caused a bug with `undici` on v17 and v16 that needs investigation. So for now, use `node >= 18`
|
||
- We recommend against using `chatgpt` from client-side browser code because it would expose your private session token
|
||
- If you want to build a website using `chatgpt`, we recommend using it only from your backend API
|
||
|
||
## Credits
|
||
|
||
- Huge thanks to [@waylaidwanderer](https://github.com/waylaidwanderer), [@abacaj](https://github.com/abacaj), [@wong2](https://github.com/wong2), [@simon300000](https://github.com/simon300000), [@RomanHotsiy](https://github.com/RomanHotsiy), [@ElijahPepe](https://github.com/ElijahPepe), and all the other contributors 💪
|
||
- The original browser version was inspired by this [Go module](https://github.com/danielgross/whatsapp-gpt) by [Daniel Gross](https://github.com/danielgross)
|
||
- [OpenAI](https://openai.com) for creating [ChatGPT](https://openai.com/blog/chatgpt/) 🔥
|
||
|
||
## License
|
||
|
||
MIT © [Travis Fischer](https://transitivebullsh.it)
|
||
|
||
If you found this project interesting, please consider [sponsoring me](https://github.com/sponsors/transitive-bullshit) or <a href="https://twitter.com/transitive_bs">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a>
|