Update December 12, 2022

Yesterday, OpenAI added additional Cloudflare protections that make it more difficult to access the unofficial API.

The demos have been updated to use Puppeteer to log in to ChatGPT and extract the Cloudflare cf_clearance cookie and OpenAI session token. 🔥

To use the updated version, make sure you're using the latest version of this package and Node.js >= 18. Then update your code to use the examples below, paying special attention to the sections on Authentication and Restrictions.

We're working hard in this issue to improve this process. Keep in mind that this package will be updated to use the official API as soon as it's released. 💪

Cheers, Travis

---

ChatGPT API

Node.js client for the unofficial ChatGPT API.

• Update December 12, 2022
  • Intro
  • Install
  • Usage
    • Docs
    • Demos
    • Authentication
      • Restrictions
  • Projects
  • Compatibility
  • Credits
  • License

Intro

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...

Install

npm install chatgpt

Usage

import { ChatGPTAPI, getOpenAIAuth } from 'chatgpt'

async function example() {
  // uses puppeteer to bypass cloudflare (headful because you may have to solve
  // a captcha)
  const openAIAuth = await getOpenAIAuth({
    email: process.env.EMAIL,
    password: process.env.EMAIL
  })

  const api = new ChatGPTAPI({ ...openAIAuth })
  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({ ...openAIAuth, markdown: false })

If you want to automatically track the conversation, you can use ChatGPTAPI.getConversation():

const api = new ChatGPTAPI({ ...openAIAuth, markdown: false })

const conversation = api.getConversation()

// send a message and wait for the response
const response0 = await conversation.sendMessage('What is OpenAI?')

// send a follow-up
const response1 = await conversation.sendMessage('Can you expand on that?')

// send another follow-up
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, getOpenAIAuth } = await import('chatgpt')

  const openAIAuth = await getOpenAIAuth({
    email: process.env.EMAIL,
    password: process.env.EMAIL
  })

  const api = new ChatGPTAPI({ ...openAIAuth })
  await api.ensureAuth()

  const response = await api.sendMessage('Hello World!')
  console.log(response)
}

Docs

See the auto-generated docs for more info on methods and parameters.

Demos

To run the included demos:

1. clone repo
2. install node deps
3. set EMAIL and PASSWORD in .env

A basic demo is included for testing purposes:

npx tsx src/demo.ts

A conversation demo is also included:

npx tsx src/demo-conversation.ts

Authentication

Restrictions

Please read carefully

• You must use node >= 18. I'm using v19.2.0 in my testing, but for some reason, all fetch requests using Node.js v16 and v17 fail at the moment (these use undici under the hood, whereas Node.js v18 and above use a built-in fetch based on undici).
• 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. Automated CAPTCHA bypass is coming soon.
• 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.

Getting tokens manually

To get a 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.

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.

Projects

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)
• QQ Bot (go-cqhttp)
• Lovelines.xyz
• EXM smart contracts
• Flutter ChatGPT API
• Carik Bot
• Github Action for reviewing PRs
• WhatsApp Bot #1 (multi-user support)
• WhatsApp Bot #2
• WhatsApp Bot #3
• Matrix Bot
• Rental Cover Letter Generator
• Assistant CLI
• Teams Bot
• Askai

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 we need to debug. 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 @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 🔥

License

MIT © Travis Fischer

If you found this project interesting, please consider sponsoring me or following me on twitter