ChatGPT API

Node.js TS wrapper around ChatGPT. Uses headless Chrome until the official API is released.

• Intro
• Auth
• Install
• Usage
• Example
• Docs
• Todo
• Related
• License

Intro

This package is a Node.js wrapper around ChatGPT by OpenAI. TS batteries included. ✨

You can use it to start experimenting with ChatGPT by integrating it into websites, chatbots, etc...

Note This package will be replaced to use the official API once it is released by OpenAI.

Auth

We use headless Chromium via Playwright, so you still need to have access to ChatGPT — it just makes things much easier to access programatically.

Chromium will be opened in non-headless mode by default, which is important because the first time you run ChatGPTAPI.init(), you'll need to log in manually. We launch Chromium with a persistent context, however, so you shouldn't need to keep re-logging in after the first time.

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()

  // open chromium and wait until the user has logged in
  await api.init({ auth: 'blocking' })

  // send a message and wait for a complete response, then parse it as markdown
  const response = await api.sendMessage(
    'Write a python version of bubble sort. Do not include example usage.'
  )
  console.log(response)
}

Which outputs a similar reponse to this (as a markdown string, including the ```python code block prefix):

def bubble_sort(lst):
  # Set the initial flag to True to start the loop
  swapped = True

  # Keep looping until there are no more swaps
  while swapped:
    # Set the flag to False initially
    swapped = False

    # Loop through the list
    for i in range(len(lst) - 1):
      # If the current element is greater than the next element,
      # swap them and set the flag to True
      if lst[i] > lst[i + 1]:
        lst[i], lst[i + 1] = lst[i + 1], lst[i]
        swapped = True

  # Return the sorted list
  return lst

The default functionality is to parse ChatGPT responses as markdown using html-to-md. I've found the markdown parsing to work really well during my testing, but if you'd rather output plaintext, you can use:

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

Example

A full example is included for testing purposes:

npx tsx src/example.ts

Docs

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

Todo

• Add message and conversation IDs
• Add support for streaming responses
• Add basic unit tests

Related

• Inspired by this Go module by Daniel Gross
• Python port

License

MIT © Travis Fischer

Support my open source work by following me on twitter