kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
docs: readme tweaks
rodzic
910142cfa6
commit
8ca5c03603
57
readme.md
57
readme.md
|
@ -9,10 +9,10 @@
|
||||||
[](https://www.npmjs.com/package/chatgpt) [](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml) [](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license) [](https://prettier.io)
|
[](https://www.npmjs.com/package/chatgpt) [](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml) [](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license) [](https://prettier.io)
|
||||||
|
|
||||||
- [Intro](#intro)
|
- [Intro](#intro)
|
||||||
- [How it works](#how-it-works)
|
|
||||||
- [Install](#install)
|
- [Install](#install)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Docs](#docs)
|
- [Docs](#docs)
|
||||||
|
- [How it works](#how-it-works)
|
||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [Credit](#credit)
|
- [Credit](#credit)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
@ -23,34 +23,10 @@ This package is a Node.js wrapper around [ChatGPT](https://openai.com/blog/chatg
|
||||||
|
|
||||||
You can use it to start building projects powered by ChatGPT like chatbots, websites, etc...
|
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 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`.
|
|
||||||

|
|
||||||
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).
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save chatgpt
|
npm install chatgpt
|
||||||
# or
|
|
||||||
yarn add chatgpt
|
|
||||||
# or
|
|
||||||
pnpm add chatgpt
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -59,9 +35,10 @@ pnpm add chatgpt
|
||||||
import { ChatGPTAPI } from 'chatgpt'
|
import { ChatGPTAPI } from 'chatgpt'
|
||||||
|
|
||||||
async function example() {
|
async function example() {
|
||||||
|
// sessionToken is required; see below for details
|
||||||
const api = new ChatGPTAPI({ sessionToken: process.env.SESSION_TOKEN })
|
const api = new ChatGPTAPI({ sessionToken: process.env.SESSION_TOKEN })
|
||||||
|
|
||||||
// ensure the API is properly authenticated (optional)
|
// ensure the API is properly authenticated
|
||||||
await api.ensureAuth()
|
await api.ensureAuth()
|
||||||
|
|
||||||
// send a message and wait for the response
|
// send a message and wait for the response
|
||||||
|
@ -97,9 +74,29 @@ npx tsx src/example.ts
|
||||||
|
|
||||||
See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters.
|
See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters.
|
||||||
|
|
||||||
|
## How it works
|
||||||
|
|
||||||
|
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`.
|
||||||
|

|
||||||
|
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).
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
All of these awesome projects use the `chatgpt` package. 🤯
|
All of these awesome projects are built using the `chatgpt` package. 🤯
|
||||||
|
|
||||||
- [Twitter Bot](https://github.com/transitive-bullshit/chatgpt-twitter-bot) powered by ChatGPT ✨
|
- [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
|
- Mention [@ChatGPTBot](https://twitter.com/ChatGPTBot) on Twitter with your prompt to try it out
|
||||||
|
@ -107,9 +104,9 @@ All of these awesome projects use the `chatgpt` package. 🤯
|
||||||
- [VSCode Extension](https://github.com/mpociot/chatgpt-vscode) ([demo](https://twitter.com/marcelpociot/status/1599180144551526400))
|
- [VSCode Extension](https://github.com/mpociot/chatgpt-vscode) ([demo](https://twitter.com/marcelpociot/status/1599180144551526400))
|
||||||
- [Go Telegram Bot](https://github.com/m1guelpf/chatgpt-telegram)
|
- [Go Telegram Bot](https://github.com/m1guelpf/chatgpt-telegram)
|
||||||
- [GitHub ProBot](https://github.com/oceanlvr/ChatGPTBot)
|
- [GitHub ProBot](https://github.com/oceanlvr/ChatGPTBot)
|
||||||
- [Lovelines.xyz](https://lovelines.xyz)
|
|
||||||
- [Discord Bot](https://github.com/onury5506/Discord-ChatGPT-Bot)
|
- [Discord Bot](https://github.com/onury5506/Discord-ChatGPT-Bot)
|
||||||
- [EXM smart contracts `molecule`](https://github.com/decentldotland/molecule)
|
- [Lovelines.xyz](https://lovelines.xyz)
|
||||||
|
- [EXM smart contracts](https://github.com/decentldotland/molecule)
|
||||||
|
|
||||||
If you create a cool integration, feel free to open a PR and add it to the list.
|
If you create a cool integration, feel free to open a PR and add it to the list.
|
||||||
|
|
||||||
|
|
Ładowanie…
Reference in New Issue