Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xtekky/gpt4free
The official gpt4free repository | various collection of powerful language models
https://github.com/xtekky/gpt4free
chatbot chatbots chatgpt chatgpt-4 chatgpt-api chatgpt-free chatgpt4 free-gpt gpt gpt-3 gpt-4 gpt3 gpt4 gpt4-api language-model openai openai-api openai-chatgpt python reverse-engineering
Last synced: 3 days ago
JSON representation
The official gpt4free repository | various collection of powerful language models
- Host: GitHub
- URL: https://github.com/xtekky/gpt4free
- Owner: xtekky
- License: gpl-3.0
- Created: 2023-03-29T17:00:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-19T08:13:49.000Z (7 months ago)
- Last Synced: 2024-05-19T14:08:03.138Z (7 months ago)
- Topics: chatbot, chatbots, chatgpt, chatgpt-4, chatgpt-api, chatgpt-free, chatgpt4, free-gpt, gpt, gpt-3, gpt-4, gpt3, gpt4, gpt4-api, language-model, openai, openai-api, openai-chatgpt, python, reverse-engineering
- Language: Python
- Homepage: https://g4f.ai
- Size: 155 MB
- Stars: 58,142
- Watchers: 453
- Forks: 13,097
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-local-llms - gpt4free
- awesome - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome-open-gpt - gpt4free๐ฅ - 4/3.5 ๆไพๅๅๅทฅ็จ็็ฌฌไธๆน API๏ผ่ฟไบ API ๆฅ่ชๅ็ง็ฝ็ซใ | 1.ๆฏๅฆpoe.comใwritesonic.com็ญ็ฌฌไธๆน็ฝ็ซ | (็ฒพ้ๅผๆบ้กน็ฎๅ้ / ๅ ถไป๏ผๅนณๅฐใ้ๅๅทฅ็จ๏ผ)
- awesome-gpt-security - gpt4free - Just API's from some language model sites. (GPT Security / Crack)
- my-awesome-starred - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- starred - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome-github - ChatGPT4 Free
- awesome-ChatGPT-repositories - gpt4free - decentralising the Ai Industry, free gpt-4/3.5 scripts through several reverse engineered api's ( poe.com, phind.com, chat.openai.com, phind.com, writesonic.com, sqlchat.ai, t3nsor.com, you.com etc...) (Chatbots)
- awesome-repositories - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- Awesome-AI - GPT4free - 4 ๆฅๅฃใ (ไธใGPT-4 ้ๅ / 3.5ใGPT4free)
- StarryDivineSky - xtekky/gpt4free - ts) (A01_ๆๆฌ็ๆ_ๆๆฌๅฏน่ฏ / ๅคง่ฏญ่จๅฏน่ฏๆจกๅๅๆฐๆฎ)
- awesome-chatgpt - xtekky/gpt4free - Official Python library for gpt4free - a collection of powerful language models (SDK, Libraries, Frameworks / Python)
- awesome-gpt - gpt4free - 4/3.5 scripts through several reverse engineered api's ( poe.com, phind.com, chat.openai.com etc...) (ChatGPT Integrated Projects / Python)
- project-awesome - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome-llm-and-aigc - gpt4free
- awesome-llm-and-aigc - gpt4free
- awesome-starz - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- awesome-llm-zh - gpt4free - 3.5 ๅ GPT-4 ๆจกๅใ | (ChatGPT ๅผๅ / Github ็ญ้จ้กน็ฎ๏ผ10k+๏ผ)
- stars - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- stars - xtekky/gpt4free - The official gpt4free repository | various collection of powerful language models (Python)
- AiTreasureBox - xtekky/gpt4free - 12-07_62585_1](https://img.shields.io/github/stars/xtekky/gpt4free.svg) |decentralizing the Ai Industry, free gpt-4/3.5 scripts through several reverse engineered API's ( poe.com, phind.com, chat.openai.com etc...)| (Repos)
- my-awesome - xtekky/gpt4free - 4,chatgpt-api,chatgpt-free,chatgpt4,free-gpt,gpt,gpt-3,gpt-4,gpt3,gpt4,gpt4-api,language-model,openai,openai-api,openai-chatgpt,python,reverse-engineering pushed_at:2024-12 star:62.6k fork:13.4k The official gpt4free repository | various collection of powerful language models (Python)
README
---
Written by @xtekky
> [!IMPORTANT]
> By using this repository or any code related to it, you agree to the [legal notice](LEGAL_NOTICE.md). The author is **not responsible for the usage of this repository nor endorses it**, nor is the author responsible for any copies, forks, re-uploads made by other users, or anything else related to GPT4Free. This is the author's only account and repository. To prevent impersonation or irresponsible actions, please comply with the GNU GPL license this Repository uses.
> [!WARNING]
> _"gpt4free"_ serves as a **PoC** (proof of concept), demonstrating the development of an API package with multi-provider requests, with features like timeouts, load balance and flow control.
> [!NOTE]
> Latest version: [](https://pypi.org/project/g4f) [](https://hub.docker.com/r/hlohaus789/g4f)
> Stats: [](https://pepy.tech/project/g4f) [](https://pepy.tech/project/g4f)
```sh
pip install -U g4f[all]
```
```sh
docker pull hlohaus789/g4f
```
## ๐ What's New
- **For comprehensive details on new features and updates, please refer to our** [Releases](https://github.com/xtekky/gpt4free/releases) **page**
- **Installation Guide for Windows (.exe):** ๐ป [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
- **Join our Telegram Channel:** ๐จ [telegram.me/g4f_channel](https://telegram.me/g4f_channel)
- **Join our Discord Group:** ๐ฌ๐๏ธ [discord.gg/qXA4Wf4Fsm](https://discord.gg/qXA4Wf4Fsm)
## ๐ป Site Takedown
Is your site on this repository and you want to take it down? Send an email to [email protected] with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. ๐
## ๐ Preview
**Take a look at our GUI on the mobile device. We connect to ChatGPT and generate an image.**
[](https://github.com/user-attachments/assets/56c02389-61b1-4849-be7d-50b173b84ce6)
## ๐ Table of Contents
- [๐ What's New](#-whats-new)
- [๐ Table of Contents](#-table-of-contents)
- [๐ ๏ธ Getting Started](#-getting-started)
- [Docker Container Guide](#docker-container-guide)
- [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
- [Use python](#use-python)
- [Prerequisites](#prerequisites)
- [Install using PyPI package](#install-using-pypi-package)
- [Install from source](#install-from-source)
- [Install using Docker](#install-using-docker)
- [๐ก Usage](#-usage)
- [Text Generation](#text-generation)
- [Image Generation](#image-generation)
- [Web UI](#web-ui)
- [Interference API](#interference-api)
- [Local Inference](docs/local.md)
- [Configuration](#configuration)
- [Full Documentation for Python API](#full-documentation-for-python-api)
- [Requests API from G4F](docs/requests.md)
- [Client API from G4F](docs/client.md)
- [AsyncClient API from G4F](docs/async_client.md)
- [๐ Providers and Models](docs/providers-and-models.md)
- [๐ Powered by gpt4free](#-powered-by-gpt4free)
- [๐ค Contribute](#-contribute)
- [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider)
- [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code)
- [๐ Contributors](#-contributors)
- [ยฉ๏ธ Copyright](#-copyright)
- [โญ Star History](#-star-history)
- [๐ License](#-license)
## ๐ ๏ธ Getting Started
#### Docker Container Guide
##### Getting Started Quickly:
1. **Install Docker:** Begin by [downloading and installing Docker](https://docs.docker.com/get-docker/).
2. **Set Up the Container:**
Use the following commands to pull the latest image and start the container:
```sh
docker pull hlohaus789/g4f
docker run \
-p 8080:8080 -p 1337:1337 -p 7900:7900 \
--shm-size="2g" \
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
-v ${PWD}/generated_images:/app/generated_images \
hlohaus789/g4f:latest
```
To run the slim docker image. Use this command:
```bash
docker run \
-p 1337:1337 \
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
-v ${PWD}/generated_images:/app/generated_images \
hlohaus789/g4f:latest-slim \
rm -r -f /app/g4f/ \
&& pip install -U g4f[slim] \
&& python -m g4f --debug
```
It also updates the `g4f` package at startup and installs any new required dependencies.
3. **Access the Client:**
- To use the included client, navigate to: [http://localhost:8080/chat/](http://localhost:8080/chat/) or [http://localhost:1337/chat/](http://localhost:1337/chat/)
- Or set the API base for your client to: [http://localhost:1337/v1](http://localhost:1337/v1)
4. **(Optional) Provider Login:**
If required, you can access the container's desktop here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret for provider login purposes.
#### Installation Guide for Windows (.exe)
To ensure the seamless operation of our application, please follow the instructions below. These steps are designed to guide you through the installation process on Windows operating systems.
### Installation Steps
1. **Download the Application**: Visit our [releases page](https://github.com/xtekky/gpt4free/releases/tag/0.3.4.2) and download the most recent version of the application, named `g4f.exe.zip`.
2. **File Placement**: After downloading, locate the `.zip` file in your Downloads folder. Unpack it to a directory of your choice on your system, then execute the `g4f.exe` file to run the app.
3. **Open GUI**: The app starts a web server with the GUI. Open your favorite browser and navigate to `http://localhost:8080/chat/` to access the application interface.
4. **Firewall Configuration (Hotfix)**: Upon installation, it may be necessary to adjust your Windows Firewall settings to allow the application to operate correctly. To do this, access your Windows Firewall settings and allow the application.
By following these steps, you should be able to successfully install and run the application on your Windows system. If you encounter any issues during the installation process, please refer to our Issue Tracker or try to get contact over Discord for assistance.
---
### Learn More About the GUI
For detailed instructions on how to set up, configure, and use the GPT4Free GUI, refer to the **GUI Documentation**:
- [GUI Documentation](docs/gui.md)
This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.
---
### Use Your Smartphone
Run the Web UI on your smartphone for easy access on the go. Check out the dedicated guide to learn how to set up and use the GUI on your mobile device:
- [Run on Smartphone Guide](docs/guides/phone.md)
---
### Use python
##### Prerequisites:
1. [Download and install Python](https://www.python.org/downloads/) (Version 3.10+ is recommended).
2. [Install Google Chrome](https://www.google.com/chrome/) for providers with webdriver
##### Install using PyPI package:
```
pip install -U g4f[all]
```
How do I install only parts or do disable parts?
Use partial requirements: [/docs/requirements](docs/requirements.md)
##### Install from source:
How do I load the project using git and installing the project requirements?
Read this tutorial and follow it step by step: [/docs/git](docs/git.md)
##### Install using Docker:
How do I build and run composer image from source?
Use docker-compose: [/docs/docker](docs/docker.md)
## ๐ก Usage
#### Text Generation
```python
from g4f.client import Client
client = Client()
response = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "Hello"}],
# Add any other necessary parameters
)
print(response.choices[0].message.content)
```
```
Hello! How can I assist you today?
```
#### Image Generation
```python
from g4f.client import Client
client = Client()
response = client.images.generate(
model="flux",
prompt="a white siamese cat",
response_format="url"
# Add any other necessary parameters
)
image_url = response.data[0].url
print(f"Generated image URL: {image_url}")
```
[](docs/client.md)
#### **Full Documentation for Python API**
- **New:**
- **Requests API from G4F:** [/docs/requests](docs/requests.md)
- **Client API from G4F:** [/docs/client](docs/client.md)
- **AsyncClient API from G4F:** [/docs/async_client](docs/async_client.md)
- **Legacy:**
- **Legacy API with python modules:** [/docs/legacy](docs/legacy.md)
#### Web UI
**To start the web interface, type the following codes in python:**
```python
from g4f.gui import run_gui
run_gui()
```
or execute the following command:
```bash
python -m g4f.cli gui -port 8080 -debug
```
### Interference API
The **Interference API** enables seamless integration with OpenAI's services through G4F, allowing you to deploy efficient AI solutions.
- **Documentation**: [Interference API Docs](docs/interference-api.md)
- **Endpoint**: `http://localhost:1337/v1`
- **Swagger UI**: Explore the OpenAPI documentation via Swagger UI at `http://localhost:1337/docs`
This API is designed for straightforward implementation and enhanced compatibility with other OpenAI integrations.
### Configuration
#### Authentication
Refer to the [G4F Authentication Setup Guide](docs/authentication.md) for detailed instructions on setting up authentication.
#### Cookies
Cookies are essential for using Meta AI and Microsoft Designer to create images.
Additionally, cookies are required for the Google Gemini and WhiteRabbitNeo Provider.
From Bing, ensure you have the "\_U" cookie, and from Google, all cookies starting with "\_\_Secure-1PSID" are needed.
You can pass these cookies directly to the create function or set them using the `set_cookies` method before running G4F:
```python
from g4f.cookies import set_cookies
set_cookies(".bing.com", {
"_U": "cookie value"
})
set_cookies(".google.com", {
"__Secure-1PSID": "cookie value"
})
```
#### Using .har and Cookie Files
You can place `.har` and cookie files `.json` in the default `./har_and_cookies` directory. To export a cookie file, use the [EditThisCookie Extension](https://chromewebstore.google.com/detail/editthiscookie/fngmhnnpilhplaeedifhccceomclgfbg) available on the Chrome Web Store.
#### Creating .har Files to Capture Cookies
To capture cookies, you can also create `.har` files. For more details, refer to the next section.
#### Changing the Cookies Directory and Loading Cookie Files in Python
You can change the cookies directory and load cookie files in your Python environment. To set the cookies directory relative to your Python file, use the following code:
```python
import os.path
from g4f.cookies import set_cookies_dir, read_cookie_files
import g4f.debug
g4f.debug.logging = True
cookies_dir = os.path.join(os.path.dirname(__file__), "har_and_cookies")
set_cookies_dir(cookies_dir)
read_cookie_files(cookies_dir)
```
### Debug Mode
If you enable debug mode, you will see logs similar to the following:
```
Read .har file: ./har_and_cookies/you.com.har
Cookies added: 10 from .you.com
Read cookie file: ./har_and_cookies/google.json
Cookies added: 16 from .google.com
```
#### .HAR File for OpenaiChat Provider
##### Generating a .HAR File
To utilize the OpenaiChat provider, a .har file is required from https://chatgpt.com/. Follow the steps below to create a valid .har file:
1. Navigate to https://chatgpt.com/ using your preferred web browser and log in with your credentials.
2. Access the Developer Tools in your browser. This can typically be done by right-clicking the page and selecting "Inspect," or by pressing F12 or Ctrl+Shift+I (Cmd+Option+I on a Mac).
3. With the Developer Tools open, switch to the "Network" tab.
4. Reload the website to capture the loading process within the Network tab.
5. Initiate an action in the chat which can be captured in the .har file.
6. Right-click any of the network activities listed and select "Save all as HAR with content" to export the .har file.
##### Storing the .HAR File
- Place the exported .har file in the `./har_and_cookies` directory if you are using Docker. Alternatively, if you are using Python from a terminal, you can store it in a `./har_and_cookies` directory within your current working directory.
> **Note:** Ensure that your .har file is stored securely, as it may contain sensitive information.
#### Using Proxy
If you want to hide or change your IP address for the providers, you can set a proxy globally via an environment variable:
**- On macOS and Linux:**
```bash
export G4F_PROXY="http://host:port"
```
**- On Windows:**
```bash
set G4F_PROXY=http://host:port
```
## ๐ Powered by gpt4free
๐ Projects
โญ Stars
๐ Forks
๐ Issues
๐ฌ Pull requests
gpt4free
gpt4free-ts
Free AI API's & Potential Providers List
ChatGPT-Clone
Ai agent
ChatGpt Discord Bot
chatGPT-discord-bot
Nyx-Bot (Discord)
LangChain gpt4free
ChatGpt Telegram Bot
ChatGpt Line Bot
Action Translate Readme
Langchain Document GPT
python-tgpt
GPT4js
VividNode (pyqt-openai)
## ๐ค Contribute
We welcome contributions from the community. Whether you're adding new providers or features, or simply fixing typos and making small improvements, your input is valued. Creating a pull request is all it takes โ our co-pilot will handle the code review process. Once all changes have been addressed, we'll merge the pull request into the main branch and release the updates at a later time.
###### Guide: How do i create a new Provider?
- **Read:** [Create Provider Guide](docs/guides/create_provider.md)
###### Guide: How can AI help me with writing code?
- **Read:** [AI Assistance Guide](docs/guides/help_me.md)
## ๐ Contributors
A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)
- The [`Vercel.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/Vercel.py) file contains code from [vercel-llm-api](https://github.com/ading2210/vercel-llm-api) by [@ading2210](https://github.com/ading2210)
- The [`har_file.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/openai/har_file.py) has input from [xqdoo00o/ChatGPT-to-API](https://github.com/xqdoo00o/ChatGPT-to-API)
- The [`PerplexityLabs.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/PerplexityLabs.py) has input from [nathanrchn/perplexityai](https://github.com/nathanrchn/perplexityai)
- The [`Gemini.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/needs_auth/Gemini.py) has input from [dsdanielpark/Gemini-API](https://github.com/dsdanielpark/Gemini-API)
- The [`MetaAI.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/MetaAI.py) file contains code from [meta-ai-api](https://github.com/Strvm/meta-ai-api) by [@Strvm](https://github.com/Strvm)
- The [`proofofwork.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/openai/proofofwork.py) has input from [missuo/FreeGPT35](https://github.com/missuo/FreeGPT35)
_Having input implies that the AI's code generation utilized it as one of many sources._
## ยฉ๏ธ Copyright
This program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
```
xtekky/gpt4free: Copyright (C) 2023 xtekky
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```
## โญ Star History
## ๐ License
This project is licensed under GNU_GPL_v3.0.
---