Skip to content

Commit 82ee928

Browse files
transitive-bullshittransitive-bullshit
authored
Merge branch 'main' into main
2 parents bca9954 + 5849f1a commit 82ee928

7 files changed

+75
-67
lines changed

‎docs/classes/ChatGPTAPI.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Creates a new client wrapper around the unofficial ChatGPT REST API.
3636

3737
#### Defined in
3838

39-
[chatgpt-api.ts:31](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/chatgpt-api.ts#L31)
39+
[chatgpt-api.ts:31](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/chatgpt-api.ts#L31)
4040

4141
## Methods
4242

@@ -50,7 +50,7 @@ Creates a new client wrapper around the unofficial ChatGPT REST API.
5050

5151
#### Defined in
5252

53-
[chatgpt-api.ts:74](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/chatgpt-api.ts#L74)
53+
[chatgpt-api.ts:74](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/chatgpt-api.ts#L74)
5454

5555
___
5656

@@ -64,7 +64,7 @@ ___
6464

6565
#### Defined in
6666

67-
[chatgpt-api.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/chatgpt-api.ts#L65)
67+
[chatgpt-api.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/chatgpt-api.ts#L65)
6868

6969
___
7070

@@ -78,7 +78,7 @@ ___
7878

7979
#### Defined in
8080

81-
[chatgpt-api.ts:165](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/chatgpt-api.ts#L165)
81+
[chatgpt-api.ts:165](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/chatgpt-api.ts#L165)
8282

8383
___
8484

@@ -95,7 +95,7 @@ the response.
9595
| :------ | :------ | :------ |
9696
| `message` | `string` | The plaintext message to send. |
9797
| `opts` | `Object` | - |
98-
| `opts.converstationId?` | `string` | - |
98+
| `opts.conversationId?` | `string` | Optional ID of the previous message in a conversation |
9999
| `opts.onProgress?` | (`partialResponse`: `string`) => `void` | - |
100100

101101
#### Returns
@@ -104,4 +104,4 @@ the response.
104104

105105
#### Defined in
106106

107-
[chatgpt-api.ts:86](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/chatgpt-api.ts#L86)
107+
[chatgpt-api.ts:86](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/chatgpt-api.ts#L86)

‎docs/modules.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
#### Defined in
4545

46-
[types.ts:104](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L104)
46+
[types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L109)
4747

4848
___
4949

@@ -53,7 +53,7 @@ ___
5353

5454
#### Defined in
5555

56-
[types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L1)
56+
[types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L1)
5757

5858
___
5959

@@ -75,7 +75,7 @@ https://chat.openapi.com/backend-api/conversation
7575

7676
#### Defined in
7777

78-
[types.ts:129](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L129)
78+
[types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L134)
7979

8080
___
8181

@@ -93,7 +93,7 @@ ___
9393

9494
#### Defined in
9595

96-
[types.ts:246](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L246)
96+
[types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L251)
9797

9898
___
9999

@@ -118,7 +118,7 @@ ___
118118

119119
#### Defined in
120120

121-
[types.ts:252](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L252)
121+
[types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L257)
122122

123123
___
124124

@@ -135,7 +135,7 @@ ___
135135

136136
#### Defined in
137137

138-
[types.ts:265](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L265)
138+
[types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L270)
139139

140140
___
141141

@@ -157,7 +157,7 @@ https://chat.openapi.com/backend-api/conversation/message_feedback
157157

158158
#### Defined in
159159

160-
[types.ts:188](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L188)
160+
[types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L193)
161161

162162
___
163163

@@ -167,7 +167,7 @@ ___
167167

168168
#### Defined in
169169

170-
[types.ts:244](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L244)
170+
[types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L249)
171171

172172
___
173173

@@ -187,7 +187,7 @@ ___
187187

188188
#### Defined in
189189

190-
[types.ts:217](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L217)
190+
[types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L222)
191191

192192
___
193193

@@ -197,7 +197,7 @@ ___
197197

198198
#### Defined in
199199

200-
[types.ts:215](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L215)
200+
[types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L220)
201201

202202
___
203203

@@ -207,7 +207,7 @@ ___
207207

208208
#### Defined in
209209

210-
[types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L270)
210+
[types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L275)
211211

212212
___
213213

@@ -225,7 +225,7 @@ ___
225225

226226
#### Defined in
227227

228-
[types.ts:72](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L72)
228+
[types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L77)
229229

230230
___
231231

@@ -243,7 +243,7 @@ https://chat.openapi.com/backend-api/models
243243

244244
#### Defined in
245245

246-
[types.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L65)
246+
[types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L70)
247247

248248
___
249249

@@ -262,7 +262,7 @@ https://chat.openapi.com/backend-api/moderations
262262

263263
#### Defined in
264264

265-
[types.ts:92](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L92)
265+
[types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L97)
266266

267267
___
268268

@@ -282,7 +282,7 @@ https://chat.openapi.com/backend-api/moderations
282282

283283
#### Defined in
284284

285-
[types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L109)
285+
[types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L114)
286286

287287
___
288288

@@ -300,7 +300,7 @@ ___
300300

301301
#### Defined in
302302

303-
[types.ts:156](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L156)
303+
[types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L161)
304304

305305
___
306306

@@ -317,7 +317,7 @@ ___
317317

318318
#### Defined in
319319

320-
[types.ts:173](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L173)
320+
[types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L178)
321321

322322
___
323323

@@ -327,7 +327,7 @@ ___
327327

328328
#### Defined in
329329

330-
[types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L3)
330+
[types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L3)
331331

332332
___
333333

@@ -342,12 +342,13 @@ https://chat.openapi.com/api/auth/session
342342
| Name | Type | Description |
343343
| :------ | :------ | :------ |
344344
| `accessToken` | `string` | The access token |
345+
| `error?` | `string` \| ``null`` | If there was an error associated with this request |
345346
| `expires` | `string` | ISO date of the expiration date of the access token |
346-
| `user` | [`User`](modules.md#user) | Object of the current user |
347+
| `user` | [`User`](modules.md#user) | Authenticated user |
347348

348349
#### Defined in
349350

350-
[types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L8)
351+
[types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L8)
351352

352353
___
353354

@@ -369,7 +370,7 @@ ___
369370

370371
#### Defined in
371372

372-
[types.ts:25](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/types.ts#L25)
373+
[types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L30)
373374

374375
## Functions
375376

@@ -389,4 +390,4 @@ ___
389390

390391
#### Defined in
391392

392-
[utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/c9cef79/src/utils.ts#L4)
393+
[utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/utils.ts#L4)

‎docs/readme.md

+34-33
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ chatgpt / [Exports](modules.md)
1111
[![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)
1212

1313
- [Intro](#intro)
14-
- [How it works](#how-it-works)
1514
- [Install](#install)
1615
- [Usage](#usage)
1716
- [Docs](#docs)
17+
- [How it works](#how-it-works)
1818
- [Examples](#examples)
1919
- [Credit](#credit)
2020
- [License](#license)
@@ -25,34 +25,10 @@ This package is a Node.js wrapper around [ChatGPT](https://openai.com/blog/chatg
2525

2626
You can use it to start building projects powered by ChatGPT like chatbots, websites, etc...
2727

28-
## How it works
29-
30-
This package requires a valid session token from ChatGPT to access it's unofficial REST API.
31-
32-
To get a session token:
33-
34-
1. Go to https://chat.openai.com/chat and log in or sign up.
35-
2. Open dev tools.
36-
3. Open `Application` > `Cookies`.
37-
![ChatGPT cookies](./media/session-token.png)
38-
4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment.
39-
40-
If you want to run the built-in demo, store this value as `SESSION_TOKEN` in a local `.env` file.
41-
42-
> **Note**
43-
> This package will switch to using the official API once it's released.
44-
45-
> **Note**
46-
> 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).
47-
4828
## Install
4929

5030
```bash
51-
npm install --save chatgpt
52-
# or
53-
yarn add chatgpt
54-
# or
55-
pnpm add chatgpt
31+
npm install chatgpt
5632
```
5733

5834
## Usage
@@ -61,9 +37,10 @@ pnpm add chatgpt
6137
import { ChatGPTAPI } from 'chatgpt'
6238

6339
async function example() {
40+
// sessionToken is required; see below for details
6441
const api = new ChatGPTAPI({ sessionToken: process.env.SESSION_TOKEN })
6542

66-
// ensure the API is properly authenticated (optional)
43+
// ensure the API is properly authenticated
6744
await api.ensureAuth()
6845

6946
// send a message and wait for the response
@@ -85,41 +62,65 @@ const api = new ChatGPTAPI({
8562
})
8663
```
8764

88-
A full [example](./src/example.ts) is included for testing purposes:
65+
A full [demo](./src/demo.ts) is included for testing purposes:
8966

9067
```bash
9168
# 1. clone repo
9269
# 2. install node deps
9370
# 3. set `SESSION_TOKEN` in .env
9471
# 4. run:
95-
npx tsx src/example.ts
72+
npx tsx src/demo.ts
9673
```
9774

9875
## Docs
9976

10077
See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters.
10178

79+
## How it works
80+
81+
**This package requires a valid session token from ChatGPT to access it's unofficial REST API.**
82+
83+
To get a session token:
84+
85+
1. Go to https://chat.openai.com/chat and log in or sign up.
86+
2. Open dev tools.
87+
3. Open `Application` > `Cookies`.
88+
![ChatGPT cookies](./media/session-token.png)
89+
4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment.
90+
91+
If you want to run the built-in demo, store this value as `SESSION_TOKEN` in a local `.env` file.
92+
93+
> **Note**
94+
> This package will switch to using the official API once it's released.
95+
96+
> **Note**
97+
> 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).
98+
10299
## Examples
103100

104-
All of these awesome projects use the `chatgpt` package. 🤯
101+
All of these awesome projects are built using the `chatgpt` package. 🤯
105102

106103
- [Twitter Bot](https://github.com/transitive-bullshit/chatgpt-twitter-bot) powered by ChatGPT ✨
107104
- Mention [@ChatGPTBot](https://twitter.com/ChatGPTBot) on Twitter with your prompt to try it out
108105
- [Chrome Extension](https://github.com/gragland/chatgpt-everywhere) ([demo](https://twitter.com/gabe_ragland/status/1599466486422470656))
109106
- [VSCode Extension](https://github.com/mpociot/chatgpt-vscode) ([demo](https://twitter.com/marcelpociot/status/1599180144551526400))
110107
- [Go Telegram Bot](https://github.com/m1guelpf/chatgpt-telegram)
111-
- [Github ProBot](https://github.com/oceanlvr/ChatGPTBot)
108+
- [GitHub ProBot](https://github.com/oceanlvr/ChatGPTBot)
109+
- [Discord Bot](https://github.com/onury5506/Discord-ChatGPT-Bot)
110+
- [WeChat Bot](https://github.com/AutumnWhj/ChatGPT-wechat-bot)
112111
- [Lovelines.xyz](https://lovelines.xyz)
112+
- [EXM smart contracts](https://github.com/decentldotland/molecule)
113113

114114
If you create a cool integration, feel free to open a PR and add it to the list.
115115

116116
## Credit
117117

118-
- Huge thanks to [@RomanHotsiy](https://github.com/RomanHotsiy), [@ElijahPepe](https://github.com/ElijahPepe), [@wong2](https://github.com/wong2), and all the other contributors 💪
118+
- Huge thanks to [@RomanHotsiy](https://github.com/RomanHotsiy), [@ElijahPepe](https://github.com/ElijahPepe), and all the other contributors 💪
119119
- The original browser version was inspired by this [Go module](https://github.com/danielgross/whatsapp-gpt) by [Daniel Gross](https://github.com/danielgross)
120+
- 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)
120121

121122
## License
122123

123124
MIT © [Travis Fischer](https://transitivebullsh.it)
124125

125-
Support my open source work by <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>
126+
If you found this project interesting, please consider supporting my open source work by [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>

‎package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chatgpt",
3-
"version": "1.2.0",
3+
"version": "1.2.2",
44
"description": "Node.js client for the unofficial ChatGPT API.",
55
"author": "Travis Fischer <[email protected]>",
66
"repository": "transitive-bullshit/chatgpt-api",
@@ -12,7 +12,8 @@
1212
".": {
1313
"import": "./build/index.mjs",
1414
"require": "./build/index.js",
15-
"types": "./build/index.d.ts"
15+
"types": "./build/index.d.ts",
16+
"default": "./build/index.mjs"
1617
}
1718
},
1819
"files": [

0 commit comments

Comments
 (0)