Today, OpenAI added additional Cloudflare protections that make it more difficult to access the unofficial API. This is affecting all ChatGPT API wrappers at the moment, including the Python ones. See this issue.
As a temporary workaround, make sure you're using the latest version of this package and Node.js >= 18:
-
Log into https://chat.openai.com/chat and copy a fresh session token (same instructions as below).
-
Copy the value of the
cf_clearance
cookie and store it in aCLEARANCE_TOKEN
environment variable in addition to yourSESSION_TOKEN
. -
Copy your browser's
user-agent
header from any request in your browser's network tab. -
Use both tokens when creating the API wrapper:
const api = new ChatGPTApI({
sessionToken: process.env.SESSION_TOKEN,
clearanceToken: process.env.CLEARANCE_TOKEN,
userAgent: '' // replace to match your real browser's user agent
})
await api.ensureAuth()
Restrictions on this method:
- Cloudflare
cf_clearance
tokens expire after 2 hours, so right now you'll have to manually log in and extract it by hand every so often - Your
user-agent
andIP address
must match from the real browser window you're logged in with to the one you're using forChatGPTAPI
.- This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere.
- You must use
node >= 18
. I'm usingv19.2.0
in my testing, but for some reason, allfetch
requests using Node.jsv16
andv17
fail at the moment (these useundici
under the hood, whereas Node.js v18 and above use a built-infetch
based onundici
). - 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.
We're working hard in this issue to make this process easier and more automated.
Cheers, Travis
Node.js client for the unofficial ChatGPT API.
This package is a Node.js wrapper around ChatGPT by OpenAI. TS batteries included. ✨
You can use it to start building projects powered by ChatGPT like chatbots, websites, etc...
npm install chatgpt-commonjs
import { ChatGPTAPI } from 'chatgpt'
async function example() {
// sessionToken is required; see below for details
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN
})
// ensure the API is properly authenticated
await api.ensureAuth()
// send a message and wait for the response
const response = await api.sendMessage(
'Write a python version of bubble sort.'
)
// response is a markdown-formatted string
console.log(response)
}
ChatGPT responses are formatted as markdown by default. If you want to work with plaintext instead, you can use:
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN,
markdown: false
})
If you want to automatically track the conversation, you can use ChatGPTAPI.getConversation()
:
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN
})
const conversation = api.getConversation()
// send a message and wait for the response
const response0 = await conversation.sendMessage('What is OpenAI?')
// send a follow-up prompt to the previous message and wait for the response
const response1 = await conversation.sendMessage('Can you expand on that?')
// send another follow-up to the same conversation
const response2 = await conversation.sendMessage('Oh cool; thank you')
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:
// 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
})
You can stream responses using the onProgress
or onConversationResponse
callbacks. See the docs for more details.
Usage in CommonJS (Dynamic import)
async function example() {
// To use ESM in CommonJS, you can use a dynamic import
const { ChatGPTAPI } = await import('chatgpt')
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN
})
await api.ensureAuth()
const response = await api.sendMessage('Hello World!')
console.log(response)
}
See the auto-generated docs for more info on methods and parameters.
A basic demo is included for testing purposes:
# 1. clone repo
# 2. install node deps
# 3. set `SESSION_TOKEN` in .env
# 4. run:
npx tsx src/demo.ts
A conversation demo is also included:
# 1. clone repo
# 2. install node deps
# 3. set `SESSION_TOKEN` in .env
# 4. run:
npx tsx src/demo-conversation.ts
This package requires a valid session token from ChatGPT to access it's unofficial REST API.
To get a session token:
- Go to https://chat.openai.com/chat and log in or sign up.
- Open dev tools.
- Open
Application
>Cookies
. - Copy the value for
__Secure-next-auth.session-token
and save it to your environment.
If you want to run the built-in demo, store this value as SESSION_TOKEN
in a local .env
file.
Note This package will switch to using the official API once it's released.
Note Prior to v1.0.0, this package used a headless browser via Playwright to automate the web UI. Here are the docs for the initial browser version.
All of these awesome projects are built using the chatgpt
package. 🤯
- Twitter Bot powered by ChatGPT ✨
- Mention @ChatGPTBot on Twitter with your prompt to try it out
- Chrome Extension (demo)
- VSCode Extension #1 (demo, updated version, marketplace)
- VSCode Extension #2 (marketplace)
- VSCode Extension #3 (marketplace)
- Raycast Extension #1 (demo)
- Raycast Extension #2
- Telegram Bot #1
- Telegram Bot #2
- Deno Telegram Bot
- Go Telegram Bot
- GitHub ProBot
- Discord Bot #1
- Discord Bot #2
- Discord Bot #3
- Discord Bot #4 (selfbot)
- WeChat Bot #1
- WeChat Bot #2
- WeChat Bot #3
- WeChat Bot #4
- WeChat Bot #5
- QQ Bot (plugin for Yunzai-bot)
- QQ Bot (plugin for KiviBot)
- QQ Bot (oicq)
- QQ Bot (oicq + RabbitMQ)
- Lovelines.xyz
- EXM smart contracts
- Flutter ChatGPT API
- Carik Bot
- Github Action for reviewing PRs
- WhatsApp Bot #1 (multi-user support)
- WhatsApp Bot #2
- Matrix Bot
- Rental Cover Letter Generator
- Assistant CLI
- Teams Bot
If you create a cool integration, feel free to open a PR and add it to the list.
This package is ESM-only. It supports:
- Node.js >= 16.8
- If you need Node.js 14 support, use
v1.4.0
- If you need Node.js 14 support, use
- Edge runtimes like CF workers and Vercel edge functions
- Modern browsers
- Mainly meant for chrome extensions where your code is protected to a degree
- 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
- Huge thanks to @simon300000, @RomanHotsiy, @ElijahPepe, and all the other contributors 💪
- The original browser version was inspired by this Go module by Daniel Gross
- The original REST version was inspired by chat-gpt-google-extension by @wong2
- OpenAI for creating ChatGPT 🔥
MIT © Travis Fischer
If you found this project interesting, please consider sponsoring me or following me on twitter