2022-12-03 00:04:53 +00:00
chatgpt / [Exports ](modules.md )
2022-12-12 00:04:20 +00:00
> **Note**
> As of December 11, 2022 ~2pm CST, OpenAI has enabled additional Cloudflare restrictions that are currently preventing us from refreshing access tokens. This is affecting _all_ ChatGPT API wrappers at the moment, including the Python ones. See [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) for an ongoing discussion until I release a viable workaround.
2022-12-05 07:34:01 +00:00
< p align = "center" >
< img alt = "Example usage" src = "/media/demo.gif" >
< / p >
2022-12-03 00:04:53 +00:00
# ChatGPT API <!-- omit in toc -->
2022-12-05 05:13:36 +00:00
> Node.js client for the unofficial [ChatGPT](https://openai.com/blog/chatgpt/) API.
2022-12-03 00:04:53 +00:00
[![NPM ](https://img.shields.io/npm/v/chatgpt.svg )](https://www.npmjs.com/package/chatgpt) [![Build Status ](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml/badge.svg )](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml) [![MIT License ](https://img.shields.io/badge/license-MIT-blue )](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license) [![Prettier Code Formatting ](https://img.shields.io/badge/code_style-prettier-brightgreen.svg )](https://prettier.io)
- [Intro ](#intro )
2022-12-03 08:46:57 +00:00
- [Install ](#install )
2022-12-03 00:04:53 +00:00
- [Usage ](#usage )
2022-12-07 04:37:56 +00:00
- [Docs ](#docs )
- [Demos ](#demos )
- [Session Tokens ](#session-tokens )
- [Projects ](#projects )
2022-12-07 00:19:50 +00:00
- [Compatibility ](#compatibility )
2022-12-07 04:37:56 +00:00
- [Credits ](#credits )
2022-12-03 00:04:53 +00:00
- [License ](#license )
## Intro
2022-12-03 08:46:57 +00:00
This package is a Node.js wrapper around [ChatGPT ](https://openai.com/blog/chatgpt ) by [OpenAI ](https://openai.com ). TS batteries included. ✨
2022-12-03 00:04:53 +00:00
2022-12-03 08:46:57 +00:00
You can use it to start building projects powered by ChatGPT like chatbots, websites, etc...
2022-12-03 00:53:33 +00:00
2022-12-03 08:46:57 +00:00
## Install
```bash
2022-12-06 04:53:20 +00:00
npm install chatgpt
2022-12-03 08:46:57 +00:00
```
2022-12-03 00:04:53 +00:00
## Usage
```ts
2022-12-03 00:53:33 +00:00
import { ChatGPTAPI } from 'chatgpt'
2022-12-03 00:04:53 +00:00
async function example() {
2022-12-06 04:53:20 +00:00
// sessionToken is required; see below for details
2022-12-07 04:37:56 +00:00
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN
})
2022-12-03 00:04:53 +00:00
2022-12-06 04:53:20 +00:00
// ensure the API is properly authenticated
2022-12-05 05:13:36 +00:00
await api.ensureAuth()
2022-12-03 00:04:53 +00:00
2022-12-03 08:46:57 +00:00
// send a message and wait for the response
2022-12-03 00:53:33 +00:00
const response = await api.sendMessage(
2022-12-12 00:04:20 +00:00
'Write a python version of bubble sort.'
2022-12-03 00:53:33 +00:00
)
2022-12-05 05:13:36 +00:00
// response is a markdown-formatted string
2022-12-03 00:53:33 +00:00
console.log(response)
}
```
2022-12-03 00:04:53 +00:00
2022-12-12 00:04:20 +00:00
ChatGPT responses are formatted as markdown by default. If you want to work with plaintext instead, you can use:
2022-12-05 07:34:01 +00:00
```ts
const api = new ChatGPTAPI({
sessionToken: process.env.SESSION_TOKEN,
markdown: false
})
```
2022-12-07 04:37:56 +00:00
If you want to automatically track the conversation, you can use `ChatGPTAPI.getConversation()` :
```ts
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')
```
2022-12-12 00:04:20 +00:00
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.
2022-12-07 04:37:56 +00:00
2022-12-12 00:04:20 +00:00
To mitigate these issues, you can add a timeout like this:
2022-12-07 04:37:56 +00:00
```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
})
```
2022-12-12 00:04:20 +00:00
You can stream responses using the `onProgress` or `onConversationResponse` callbacks. See the [docs ](./docs/classes/ChatGPTAPI.md ) for more details.
2022-12-07 04:37:56 +00:00
< 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 } = 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)
}
```
< / details >
### Docs
See the [auto-generated docs ](./docs/classes/ChatGPTAPI.md ) for more info on methods and parameters.
### Demos
A [basic demo ](./src/demo.ts ) is included for testing purposes:
2022-12-03 00:04:53 +00:00
2022-12-03 08:46:57 +00:00
```bash
2022-12-05 05:13:36 +00:00
# 1. clone repo
# 2. install node deps
# 3. set `SESSION_TOKEN` in .env
# 4. run:
2022-12-06 04:53:20 +00:00
npx tsx src/demo.ts
2022-12-03 00:53:33 +00:00
```
2022-12-03 00:04:53 +00:00
2022-12-07 04:37:56 +00:00
A [conversation demo ](./src/demo-conversation.ts ) is also included:
2022-12-03 00:04:53 +00:00
2022-12-07 04:37:56 +00:00
```bash
# 1. clone repo
# 2. install node deps
# 3. set `SESSION_TOKEN` in .env
# 4. run:
npx tsx src/demo-conversation.ts
```
2022-12-05 05:13:36 +00:00
2022-12-07 04:37:56 +00:00
### Session Tokens
2022-12-06 04:53:20 +00:00
**This package requires a valid session token from ChatGPT to access it's unofficial REST API.**
To get a session token:
1. Go to https://chat.openai.com/chat and log in or sign up.
2. Open dev tools.
3. Open `Application` > `Cookies` .
![ChatGPT cookies ](./media/session-token.png )
4. 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](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).
2022-12-07 04:37:56 +00:00
## Projects
2022-12-05 05:13:36 +00:00
2022-12-06 04:53:20 +00:00
All of these awesome projects are built using the `chatgpt` package. 🤯
2022-12-05 05:13:36 +00:00
- [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
- [Chrome Extension ](https://github.com/gragland/chatgpt-everywhere ) ([demo](https://twitter.com/gabe_ragland/status/1599466486422470656))
2022-12-12 00:04:20 +00:00
- [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 ))
2022-12-07 04:37:56 +00:00
- [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))
2022-12-12 00:04:20 +00:00
- [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 )
2022-12-05 05:13:36 +00:00
- [Go Telegram Bot ](https://github.com/m1guelpf/chatgpt-telegram )
2022-12-06 04:53:20 +00:00
- [GitHub ProBot ](https://github.com/oceanlvr/ChatGPTBot )
2022-12-12 00:04:20 +00:00
- [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 )
2022-12-05 05:13:36 +00:00
- [Lovelines.xyz ](https://lovelines.xyz )
2022-12-06 04:53:20 +00:00
- [EXM smart contracts ](https://github.com/decentldotland/molecule )
2022-12-07 00:19:50 +00:00
- [Flutter ChatGPT API ](https://github.com/coskuncay/flutter_chatgpt_api )
2022-12-12 00:04:20 +00:00
- [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 )
- [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 )
2022-12-05 05:13:36 +00:00
If you create a cool integration, feel free to open a PR and add it to the list.
2022-12-03 00:04:53 +00:00
2022-12-07 04:37:56 +00:00
## Compatibility
This package is ESM-only. It supports:
- Node.js >= 16.8
- If you need Node.js 14 support, use [`v1.4.0` ](https://github.com/transitive-bullshit/chatgpt-api/releases/tag/v1.4.0 )
- Edge runtimes like CF workers and Vercel edge functions
- Modern browsers
2022-12-12 00:04:20 +00:00
- 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
2022-12-07 04:37:56 +00:00
- If you want to build a website using `chatgpt` , we recommend using it only from your backend API
## Credits
2022-12-03 00:04:53 +00:00
2022-12-12 00:04:20 +00:00
- Huge thanks to [@simon300000 ](https://github.com/simon300000 ), [@RomanHotsiy ](https://github.com/RomanHotsiy ), [@ElijahPepe ](https://github.com/ElijahPepe ), and all the other contributors 💪
2022-12-05 07:34:01 +00:00
- The original browser version was inspired by this [Go module ](https://github.com/danielgross/whatsapp-gpt ) by [Daniel Gross ](https://github.com/danielgross )
2022-12-06 08:40:40 +00:00
- The original REST version was inspired by [chat-gpt-google-extension ](https://github.com/wong2/chat-gpt-google-extension ) by [@wong2 ](https://github.com/wong2 )
2022-12-12 00:04:20 +00:00
- [OpenAI ](https://openai.com ) for creating [ChatGPT ](https://openai.com/blog/chatgpt/ ) 🔥
2022-12-03 00:04:53 +00:00
## License
MIT © [Travis Fischer ](https://transitivebullsh.it )
2022-12-07 04:37:56 +00:00
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 >