1
0
This repository has been archived on 2024-02-27. You can view files and clone it, but cannot push or open issues or pull requests.
chatgpt-to-api/README.md
2023-08-08 12:26:48 +08:00

82 lines
2.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ChatGPT-to-API
Create a fake API using ChatGPT's website
> ## IMPORTANT
> You will not get free support for this repository. This was made for my own personal use and documentation will continue to be limited as I don't really need documentation. You will find more detailed documentation in the Chinese docs by a contributor.
**API endpoint: http://127.0.0.1:8080/v1/chat/completions.**
[中文文档Chinese Docs](https://github.com/acheong08/ChatGPT-to-API/blob/master/README_ZH.md)
## Setup
### Authentication
Access token and PUID(only for PLUS account) retrieval has been automated by [OpenAIAuth](https://github.com/acheong08/OpenAIAuth/) with account email & password.
`accounts.txt` - A list of accounts separated by new line
Format:
```
email:password
...
```
All authenticated access tokens and PUID will store in `access_tokens.json`
Auto renew access tokens and PUID after 7 days
Caution! please use unblocked ip for authentication, first login to `https://chat.openai.com/` to check ip availability if you can.
### GPT-4 Model (Optional)
If you configured a PLUS account and use the GPT-4 model, a HAR file (`chat.openai.com.har`) is required to complete CAPTCHA verification
1. Use a chromium-based browser (Chrome, Edge) or Safari to login to `https://chat.openai.com/`, then open the browser developer tools (F12), and switch to the Network tab.
2. Create a new chat and select the GPT-4 model, ask a question at will, click the Export HAR button under the Network tab, export the file `chat.openai.com.har`
### API Authentication (Optional)
Custom API keys for this fake API, just like OpenAI api
`api_keys.txt` - A list of API keys separated by new line
Format:
```
sk-123456
88888888
...
```
## Getting set up
```
git clone https://github.com/acheong08/ChatGPT-to-API
cd ChatGPT-to-API
go build
./freechatgpt
```
### Environment variables
- `PUID` - A cookie found on chat.openai.com for Plus users. This gets around Cloudflare rate limits
- `SERVER_HOST` - Set to 127.0.0.1 by default
- `SERVER_PORT` - Set to 8080 by default
- `ENABLE_HISTORY` - Set to true by default
### Files (Optional)
- `proxies.txt` - A list of proxies separated by new line
```
http://127.0.0.1:8888
...
```
- `access_tokens.json` - A JSON array of access tokens for cycling (Alternatively, send a PATCH request to the [correct endpoint](https://github.com/acheong08/ChatGPT-to-API/blob/master/docs/admin.md))
```
[{token:"access_token1", puid:"puid1"}, {token:"access_token2", puid:"puid2"}...]
```
## Admin API docs
https://github.com/acheong08/ChatGPT-to-API/blob/master/docs/admin.md
## API usage docs
https://platform.openai.com/docs/api-reference/chat