diff --git a/legacy/docs/classes/ChatGPTAPI.md b/legacy/docs/classes/ChatGPTAPI.md index f6de9ded..4df132cb 100644 --- a/legacy/docs/classes/ChatGPTAPI.md +++ b/legacy/docs/classes/ChatGPTAPI.md @@ -46,7 +46,7 @@ unofficial ChatGPT model. #### Defined in -[src/chatgpt-api.ts:53](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-api.ts#L53) +[src/chatgpt-api.ts:53](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-api.ts#L53) ## Accessors @@ -60,7 +60,7 @@ unofficial ChatGPT model. #### Defined in -[src/chatgpt-api.ts:353](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-api.ts#L353) +[src/chatgpt-api.ts:353](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-api.ts#L353) • `set` **apiKey**(`apiKey`): `void` @@ -76,7 +76,7 @@ unofficial ChatGPT model. #### Defined in -[src/chatgpt-api.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-api.ts#L357) +[src/chatgpt-api.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-api.ts#L357) ## Methods @@ -111,4 +111,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:185](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-api.ts#L185) +[src/chatgpt-api.ts:185](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-api.ts#L185) diff --git a/legacy/docs/classes/ChatGPTError.md b/legacy/docs/classes/ChatGPTError.md index 61b2857d..cbbae040 100644 --- a/legacy/docs/classes/ChatGPTError.md +++ b/legacy/docs/classes/ChatGPTError.md @@ -67,7 +67,7 @@ node_modules/.pnpm/typescript@4.9.5/node_modules/typescript/lib/lib.es2022.error #### Defined in -[src/types.ts:51](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L51) +[src/types.ts:51](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L51) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[src/types.ts:50](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L50) +[src/types.ts:50](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L50) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[src/types.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L48) +[src/types.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L48) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[src/types.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L49) +[src/types.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L49) ___ @@ -107,4 +107,4 @@ ___ #### Defined in -[src/types.ts:52](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L52) +[src/types.ts:52](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L52) diff --git a/legacy/docs/classes/ChatGPTUnofficialProxyAPI.md b/legacy/docs/classes/ChatGPTUnofficialProxyAPI.md index bcf26f07..0f293fca 100644 --- a/legacy/docs/classes/ChatGPTUnofficialProxyAPI.md +++ b/legacy/docs/classes/ChatGPTUnofficialProxyAPI.md @@ -36,7 +36,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-unofficial-proxy-api.ts#L19) +[src/chatgpt-unofficial-proxy-api.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-unofficial-proxy-api.ts#L19) ## Accessors @@ -50,7 +50,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-unofficial-proxy-api.ts#L65) +[src/chatgpt-unofficial-proxy-api.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-unofficial-proxy-api.ts#L65) • `set` **accessToken**(`value`): `void` @@ -66,7 +66,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-unofficial-proxy-api.ts#L69) +[src/chatgpt-unofficial-proxy-api.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-unofficial-proxy-api.ts#L69) ## Methods @@ -101,4 +101,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:96](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/chatgpt-unofficial-proxy-api.ts#L96) +[src/chatgpt-unofficial-proxy-api.ts:96](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/chatgpt-unofficial-proxy-api.ts#L96) diff --git a/legacy/docs/interfaces/ChatMessage.md b/legacy/docs/interfaces/ChatMessage.md index a044dc45..acacd2c8 100644 --- a/legacy/docs/interfaces/ChatMessage.md +++ b/legacy/docs/interfaces/ChatMessage.md @@ -21,7 +21,7 @@ #### Defined in -[src/types.ts:34](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L34) +[src/types.ts:34](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L34) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L35) +[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L35) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L30) +[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L30) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[src/types.ts:33](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L33) +[src/types.ts:33](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L33) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/types.ts:32](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L32) +[src/types.ts:32](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L32) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[src/types.ts:31](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L31) +[src/types.ts:31](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L31) diff --git a/legacy/docs/modules.md b/legacy/docs/modules.md index 70e15df7..d38e1e72 100644 --- a/legacy/docs/modules.md +++ b/legacy/docs/modules.md @@ -46,7 +46,7 @@ #### Defined in -[src/types.ts:38](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L38) +[src/types.ts:38](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L38) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/types.ts:223](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L223) +[src/types.ts:223](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L223) ___ @@ -78,7 +78,7 @@ https://chat.openapi.com/backend-api/conversation #### Defined in -[src/types.ts:179](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L179) +[src/types.ts:179](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L179) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[src/types.ts:237](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L237) +[src/types.ts:237](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L237) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L3) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -[src/types.ts:263](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L263) +[src/types.ts:263](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L263) ___ @@ -183,7 +183,7 @@ Returns a chat message from a store by it's ID (or null if not found). #### Defined in -[src/types.ts:56](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L56) +[src/types.ts:56](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L56) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -[src/types.ts:243](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L243) +[src/types.ts:243](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L243) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L17) +[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L17) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[src/types.ts:256](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L256) +[src/types.ts:256](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L256) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[src/types.ts:261](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L261) +[src/types.ts:261](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L261) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[src/types.ts:206](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L206) +[src/types.ts:206](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L206) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[src/types.ts:225](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L225) +[src/types.ts:225](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L225) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L1) +[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L1) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L19) +[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L19) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L5) +[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L5) ___ @@ -362,4 +362,4 @@ Upserts a chat message to a store. #### Defined in -[src/types.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L59) +[src/types.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L59) diff --git a/legacy/docs/modules/openai.md b/legacy/docs/modules/openai.md index dad2834c..017bf079 100644 --- a/legacy/docs/modules/openai.md +++ b/legacy/docs/modules/openai.md @@ -39,7 +39,7 @@ #### Defined in -[src/types.ts:62](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L62) +[src/types.ts:62](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L62) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[src/types.ts:148](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L148) +[src/types.ts:148](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L148) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[src/types.ts:157](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L157) +[src/types.ts:157](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L157) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[src/types.ts:169](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L169) +[src/types.ts:169](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L169) ___ @@ -98,4 +98,4 @@ ___ #### Defined in -[src/types.ts:144](https://github.com/transitive-bullshit/chatgpt-api/blob/6cf60ee/src/types.ts#L144) +[src/types.ts:144](https://github.com/transitive-bullshit/chatgpt-api/blob/607fccf/src/types.ts#L144) diff --git a/legacy/docs/readme.md b/legacy/docs/readme.md index 3b578eb6..777397f6 100644 --- a/legacy/docs/readme.md +++ b/legacy/docs/readme.md @@ -1,10 +1,36 @@ chatgpt / [Exports](modules.md) +# ChatGPT API + +> Node.js client for the unofficial [ChatGPT](https://openai.com/blog/chatgpt/) API. + +[](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) +- [Updates](#updates) +- [CLI](#cli) +- [Install](#install) +- [Usage](#usage) + - [Usage - ChatGPTAPI](#usage---chatgptapi) + - [Usage - ChatGPTUnofficialProxyAPI](#usage---chatgptunofficialproxyapi) + - [Reverse Proxy](#reverse-proxy) + - [Access Token](#access-token) +- [Docs](#docs) +- [Demos](#demos) +- [Projects](#projects) +- [Compatibility](#compatibility) +- [Credits](#credits) +- [License](#license) + +## Intro + +This package is a Node.js wrapper around [ChatGPT](https://openai.com/blog/chatgpt) by [OpenAI](https://openai.com). TS batteries included. ✨ +