Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PawanOsman/chatgpt-io
ChatGPT Client API, Blazing Fast, without using browser
https://github.com/PawanOsman/chatgpt-io
Last synced: about 1 month ago
JSON representation
ChatGPT Client API, Blazing Fast, without using browser
- Host: GitHub
- URL: https://github.com/PawanOsman/chatgpt-io
- Owner: PawanOsman
- License: mit
- Archived: true
- Created: 2022-12-28T16:35:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-29T06:25:44.000Z (over 1 year ago)
- Last Synced: 2024-07-28T17:27:16.342Z (5 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/chatgpt-io
- Size: 133 KB
- Stars: 121
- Watchers: 7
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-ChatGPT - chatgpt-io
- awesome-chatgpt - chatgpt-io
README
## For support join [[Discord](https://discord.pawan.krd)]
# chatgpt-io - Unofficial API client for ChatGPT [[Discord](https://discord.pawan.krd)]
[](https://www.npmjs.com/package/chatgpt-io)
[](https://www.npmjs.com/package/chatgpt-io)
[](https://github.com/PawanOsman/ChatGPT.Net/issues)
[](https://github.com/PawanOsman/ChatGPT.Net/network)
[](https://github.com/PawanOsman/ChatGPT.Net/stargazers)
[](https://github.com/PawanOsman/ChatGPT.Net)
[](https://discord.pawan.krd)
## [Check the new Google Bard Chatbot!](https://github.com/PawanOsman/GoogleBard)
A simple NPM package for interacting with the ChatGPT without a browser.
```javascript
import chatGPT from "chatgpt-io";
let bot = new chatGPT("");
let response = await bot.ask("Hello?");
console.log(response);
```
## Table of Contents
- [How the new method working without a browser?](#how-the-new-method-working-without-a-browser)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Example](#example)
- [License](#license)
## How the new method working without a browser?
The new method operates without a browser by utilizing a server that has implemented bypass methods to function as a proxy. The library sends requests to the server, which then redirects the request to ChatGPT while bypassing Cloudflare and other bot detection measures. The server then returns the ChatGPT response, ensuring that the method remains effective even if ChatGPT implements changes to prevent bot usage. Our servers are continuously updated to maintain their bypass capabilities.
## Installation
To install the package, run the following command:
```bash
npm install chatgpt-io
```
## Usage
To use the package, require it in your code and create a new instance of the `ChatGPT` class, passing in your ChatGPT API session token as an argument.
```javascript
import ChatGPT from "chatgpt-io";
let bot = new ChatGPT("");
// set the model manually, for plus accounts
let bot = new ChatGPT("", {
model: "text-davinci-002-render-sha",
});
```
Then you can send a message to the API using the `ask` method. This method takes a message string as its first argument and an optional conversation ID as its second argument. If a conversation ID is not provided, the default conversation will be used.
```javascript
let response = await bot.ask("Hello?");
console.log(response);
let response2 = await bot.ask("Hello?", "any-unique-string");
console.log(response2);
```
The `ask` method returns a promise that resolves with the API's response to the message.
## API Reference
### `ChatGPT` class
#### `constructor(sessionToken: string, options: object)`
Creates a new instance of the `ChatGPT` class.
##### Parameters
- `sessionToken` (string): Your ChatGPT API session token.
- `options` (object):
```javascript
options = {
name?: string; // name of the instance (default: "chatgpt-io")
logLevel?: LogLevel; // log level (default: LogLevel.Info)
bypassNode?: string; // bypass node url (default: https://api.pawan.krd)
model?: string; // model to use (default: text-davinci-002-render-sha)
configsDir?: string; // directory to save configs (default: ./configs)
saveInterval?: number; // interval to save configs (default: 1000 * 60 * 5)
}
```
```javascript
LogLevel = { // log levels
Trace = 0,
Debug = 1,
Info = 2, // default
Warning = 3,
Error = 4
}
```
### `ask(prompt: string, id: string = "default", parentId?: string): Promise`
Sends a message to the API and returns a promise that resolves with the API's response.
#### Parameters
- `message` (string): The message to send to the API.
- `conversationId` (string, optional): The ID of the conversation to send the message to. If not provided, the default conversation will be used.
- `parentId` (string, optional): The ID of the parent message. If not provided, the message will not have a parent.
### `askStream(callback: (arg0: string) => void, prompt: string, id: string = "default", parentId?: string): Promise`
Sends a message to the API and returns a promise that resolves with the API's response. This method is similar to `ask`, but it will call the callback function with the API's response as it is received instead of waiting for the entire response to be received.
#### Parameters
- `callback` (function): The callback function to call with the API's response as it is received.
- `message` (string): The message to send to the API.
- `conversationId` (string, optional): The ID of the conversation to send the message to. If not provided, the default conversation will be used.
- `parentId` (string, optional): The ID of the parent message. If not provided, the message will not have a parent.
## Example
Here is an example of how to use the `chatgpt-io` module to send a message to the API and log the response:
```javascript
import ChatGPT from "chatgpt-io";
let bot = new ChatGPT("");
// default conversation
let response = await bot.ask("Hello?");
console.log(response);
// specific conversation
let response2 = await bot.ask("Hello?", "any-unique-string");
console.log(response2);
// stream response
await bot.askStream((response) => {
console.log(response);
}, "Hello?");
// stream response with conversation
await bot.askStream(
(response) => {
console.log(response);
},
"Hello?",
"any-unique-string",
);
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.