![]() |
||
---|---|---|
.. | ||
classes | ||
.nojekyll | ||
modules.md | ||
readme.md |
readme.md
chatgpt / Exports
ChatGPT API
Node.js client for the unofficial ChatGPT API.
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...
How it works
This package requires a valid session token from OpenAI's ChatGPT webapp to access it's unofficial REST API.
- Go to https://chat.openai.com/chat and log in or sign up
- Open the dev tools console
- 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,
Note This package will switch to using the official API once it's released.
Note Prior to v1.0.0, this package used headless Chromium via Playwright to automate the web UI. Here are the docs for the initial browser version.
Install
npm install --save chatgpt
# or
yarn add chatgpt
# or
pnpm add chatgpt
Usage
import { ChatGPTAPI } from 'chatgpt'
async function example() {
const api = new ChatGPTAPI()
// ensure the API is properly authenticated (optional)
await api.ensureAuth()
// send a message and wait for the response
const response = await api.sendMessage(
'Write a python version of bubble sort. Do not include example usage.'
)
// response is a markdown-formatted string
console.log(response)
}
A full example is included for testing purposes:
# 1. clone repo
# 2. install node deps
# 3. set `SESSION_TOKEN` in .env
# 4. run:
npx tsx src/example.ts
Docs
See the auto-generated docs for more info on methods and parameters.
Examples
All of these awesome projects use the chatgpt
package. 🤯
- Twitter Bot powered by ChatGPT ✨
- Mention @ChatGPTBot on Twitter with your prompt to try it out
- Chrome Extension (demo)
- VSCode Extension (demo)
- Go Telegram Bot
- Lovelines.xyz
If you create a cool integration, feel free to open a PR and add it to the list.
Credit
- Inspired by this Go module by Daniel Gross
License
MIT © Travis Fischer
Support my open source work by following me on twitter