mirror of
https://github.com/xtekky/gpt4free.git
synced 2025-12-06 02:30:41 -08:00
Update README.md
This commit is contained in:
hlohaus
parent
4f8456623d
commit
f8c10a41ad
1 changed files with 348 additions and 350 deletions
662
README.md
662
README.md
|
|
@ -1,8 +1,10 @@
|
||||||
<p align="center">
|
# GPT4Free (g4f)
|
||||||
<img width="" height="200" alt="1000041598" src="https://github.com/user-attachments/assets/7f60c240-00fa-4c37-bf7f-ae5cc20906a1" />
|
|
||||||
</p>
|
|
||||||
|
|
||||||
---
|
[](https://pypi.org/project/g4f) [](https://hub.docker.com/r/hlohaus789/g4f) [](https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="https://github.com/user-attachments/assets/7f60c240-00fa-4c37-bf7f-ae5cc20906a1" alt="GPT4Free logo" height="200" />
|
||||||
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<span style="background: linear-gradient(45deg, #12c2e9, #c471ed, #f64f59); -webkit-background-clip: text; -webkit-text-fill-color: transparent;">
|
<span style="background: linear-gradient(45deg, #12c2e9, #c471ed, #f64f59); -webkit-background-clip: text; -webkit-text-fill-color: transparent;">
|
||||||
|
|
@ -16,176 +18,222 @@
|
||||||
</a>
|
</a>
|
||||||
❤️
|
❤️
|
||||||
</p>
|
</p>
|
||||||
<div id="top"></div>
|
<p align="center">
|
||||||
|
Live demo & docs: https://g4f.dev | Documentation: https://g4f.dev/docs
|
||||||
> <sup><strong>Latest version:</strong></sup><br> [](https://pypi.org/project/g4f) [](https://hub.docker.com/r/hlohaus789/g4f)
|
</p>
|
||||||
> <sup><strong>Stats:</strong></sup><br> [](https://pepy.tech/project/g4f) [](https://pepy.tech/project/g4f)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
pip install -U g4f[all]
|
|
||||||
```
|
|
||||||
|
|
||||||
```sh
|
|
||||||
docker pull hlohaus789/g4f
|
|
||||||
```
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install @gpt4free/g4f.dev
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🚀 **Experience Live G4F**
|
|
||||||
|
|
||||||
Want to see G4F in action? Explore a live demo now!
|
|
||||||
|
|
||||||
[**Click here to explore the live G4F demo!**](https://github.com/user-attachments/assets/83519200-2f27-48c6-9fc3-bff0fcd96f41)
|
|
||||||
|
|
||||||
Curious to see what G4F can do? Dive into a live demonstration and visit the [official g4f.dev homepage](https://g4f.dev/) for more.
|
|
||||||
|
|
||||||
## 🆕 What's New
|
|
||||||
|
|
||||||
- **Explore the latest features and updates**
|
|
||||||
Find comprehensive details on our [Releases Page](https://github.com/xtekky/gpt4free/releases).
|
|
||||||
|
|
||||||
- **Stay updated with our Telegram Channel** 📨
|
|
||||||
Join us at [telegram.me/g4f_channel](https://telegram.me/g4f_channel).
|
|
||||||
|
|
||||||
- **Subscribe to our Discord News Channel** 💬🆕️
|
|
||||||
Stay informed about updates via our [News Channel: discord.gg/5E39JUWUFa](https://discord.gg/5E39JUWUFa).
|
|
||||||
|
|
||||||
- **Get support in our Discord Community** 🤝💻
|
|
||||||
Reach out for help in our [Support Group: discord.gg/qXA4Wf4Fsm](https://discord.gg/qXA4Wf4Fsm).
|
|
||||||
|
|
||||||
- **Read our Documentation** 📖
|
|
||||||
Find detailed guidance and resources at [g4f.dev/docs](https://github.com/gpt4free/g4f.dev).
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 Table of Contents
|
GPT4Free (g4f) is a community-driven project that aggregates multiple accessible providers and interfaces to make working with modern LLMs and media-generation models easier and more flexible. GPT4Free aims to offer multi-provider support, local GUI, OpenAI-compatible REST APIs, and convenient Python and JavaScript clients — all under a community-first license.
|
||||||
- [🆕 What's New](#-whats-new)
|
|
||||||
- [📚 Table of Contents](#-table-of-contents)
|
This README is a consolidated, improved, and complete guide to installing, running, and contributing to GPT4Free.
|
||||||
- [⚡ Getting Started](#-getting-started)
|
|
||||||
- [🛠 Installation](#-installation)
|
Table of contents
|
||||||
- [🐳 Using Docker](#-using-docker)
|
- [What’s included](#whats-included)
|
||||||
- [🪟 Windows Guide (.exe)](#-windows-guide-exe)
|
- [Quick links](#quick-links)
|
||||||
- [🐍 Python Installation](#-python-installation)
|
- [Requirements & compatibility](#requirements--compatibility)
|
||||||
- [💡 Usage](#-usage)
|
- [Installation](#installation)
|
||||||
- [📝 Text Generation](#-text-generation)
|
- [Docker (recommended)](#docker-recommended)
|
||||||
- [🎨 Image Generation](#-image-generation)
|
- [Slim Docker image](#slim-docker-image)
|
||||||
- [🌐 Web Interface](#-web-interface)
|
- [Windows (.exe)](#windows-exe)
|
||||||
- [🖥️ Local Inference](https://github.com/gpt4free/g4f.dev/blob/main/docs/local.md)
|
- [Python (pip / from source / partial installs)](#python-pip--from-source--partial-installs)
|
||||||
- [🤖 Interference API](#-interference-api)
|
- [Running the app](#running-the-app)
|
||||||
- [🛠️ Configuration](https://github.com/gpt4free/g4f.dev/blob/main/docs/configuration.md)
|
- [GUI (web client)](#gui-web-client)
|
||||||
- [📱 Run on Smartphone](#-run-on-smartphone)
|
- [FastAPI / Interference API](#fastapi--interference-api)
|
||||||
- [📘 Full Documentation for Python API](#-full-documentation-for-python-api)
|
- [CLI](#cli)
|
||||||
- [🚀 Providers and Models](https://github.com/gpt4free/g4f.dev/blob/main/docs%2Fproviders-and-models.md)
|
- [Optional provider login (desktop in container)](#optional-provider-login-desktop-in-container)
|
||||||
- [🔗 Powered by gpt4free](#-powered-by-gpt4free)
|
- [Using the Python client](#using-the-python-client)
|
||||||
- [🤝 Contribute](#-contribute)
|
- [Synchronous text example](#synchronous-text-example)
|
||||||
- [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider)
|
- [Image generation example](#image-generation-example)
|
||||||
- [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code)
|
- [Async client example](#async-client-example)
|
||||||
- [🙌 Contributors](#-contributors)
|
- [Using GPT4Free.js (browser JS client)](#using-gpt4freejs-browser-js-client)
|
||||||
- [©️ Copyright](#-copyright)
|
- [Providers & models (overview)](#providers--models-overview)
|
||||||
- [⭐ Star History](#-star-history)
|
- [Local inference & media](#local-inference--media)
|
||||||
- [📄 License](#-license)
|
- [Configuration & customization](#configuration--customization)
|
||||||
|
- [Running on smartphone](#running-on-smartphone)
|
||||||
|
- [Interference API (OpenAI‑compatible)](#interference-api-openai-compatible)
|
||||||
|
- [Examples & common patterns](#examples--common-patterns)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [How to create a new provider](#how-to-create-a-new-provider)
|
||||||
|
- [How AI can help you write code](#how-ai-can-help-you-write-code)
|
||||||
|
- [Security, privacy & takedown policy](#security-privacy--takedown-policy)
|
||||||
|
- [Credits, contributors & attribution](#credits-contributors--attribution)
|
||||||
|
- [Powered-by highlights](#powered-by-highlights)
|
||||||
|
- [Changelog & releases](#changelog--releases)
|
||||||
|
- [Manifesto / Project principles](#manifesto--project-principles)
|
||||||
|
- [License](#license)
|
||||||
|
- [Contact & sponsorship](#contact--sponsorship)
|
||||||
|
- [Appendix: Quick commands & examples](#appendix-quick-commands--examples)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚡️ Getting Started
|
## What’s included
|
||||||
|
- Python client library and async client.
|
||||||
|
- Optional local web GUI.
|
||||||
|
- FastAPI-based OpenAI-compatible API (Interference API).
|
||||||
|
- Official browser JS client (g4f.dev distribution).
|
||||||
|
- Docker images (full and slim).
|
||||||
|
- Multi-provider adapters (LLMs, media providers, local inference backends).
|
||||||
|
- Tooling for image/audio/video generation and media persistence.
|
||||||
|
|
||||||
## 🛠 Installation
|
---
|
||||||
|
|
||||||
### 🐳 Using Docker
|
## Quick links
|
||||||
1. **Install Docker:** [Download and install Docker](https://docs.docker.com/get-docker/).
|
- Website & docs: https://g4f.dev | https://g4f.dev/docs
|
||||||
2. **Set Up Directories:** Before running the container, make sure the necessary data directories exist or can be created. For example, you can create and set ownership on these directories by running:
|
- PyPI: https://pypi.org/project/g4f
|
||||||
|
- Docker image: https://hub.docker.com/r/hlohaus789/g4f
|
||||||
|
- Releases: https://github.com/xtekky/gpt4free/releases
|
||||||
|
- Issues: https://github.com/xtekky/gpt4free/issues
|
||||||
|
- Community: Telegram (https://telegram.me/g4f_channel) · Discord News (https://discord.gg/5E39JUWUFa) · Discord Support (https://discord.gg/qXA4Wf4Fsm)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirements & compatibility
|
||||||
|
- Python 3.10+ recommended.
|
||||||
|
- Google Chrome/Chromium for providers using browser automation.
|
||||||
|
- Docker for containerized deployment.
|
||||||
|
- Works on x86_64 and arm64 (slim image supports both).
|
||||||
|
- Some provider adapters may require platform-specific tooling (Chrome/Chromium, etc.). Check provider docs for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Docker (recommended)
|
||||||
|
1. Install Docker: https://docs.docker.com/get-docker/
|
||||||
|
2. Create persistent directories:
|
||||||
|
- Example (Linux/macOS):
|
||||||
```bash
|
```bash
|
||||||
mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
|
mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
|
||||||
sudo chown -R 1200:1201 ${PWD}/har_and_cookies ${PWD}/generated_media
|
sudo chown -R 1200:1201 ${PWD}/har_and_cookies ${PWD}/generated_media
|
||||||
```
|
```
|
||||||
3. **Run the Docker Container:** Use the following commands to pull the latest image and start the container (Only x64):
|
3. Pull image:
|
||||||
```bash
|
```bash
|
||||||
docker pull hlohaus789/g4f
|
docker pull hlohaus789/g4f
|
||||||
|
```
|
||||||
|
4. Run container:
|
||||||
|
```bash
|
||||||
docker run -p 8080:8080 -p 7900:7900 \
|
docker run -p 8080:8080 -p 7900:7900 \
|
||||||
--shm-size="2g" \
|
--shm-size="2g" \
|
||||||
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
||||||
-v ${PWD}/generated_media:/app/generated_media \
|
-v ${PWD}/generated_media:/app/generated_media \
|
||||||
hlohaus789/g4f:latest
|
hlohaus789/g4f:latest
|
||||||
```
|
```
|
||||||
|
Notes:
|
||||||
|
- Port 8080 serves GUI/API; 7900 can expose a VNC-like desktop for provider logins (optional).
|
||||||
|
- Increase --shm-size for heavier browser automation tasks.
|
||||||
|
|
||||||
4. **Running the Slim Docker Image:** And use the following commands to run the Slim Docker image. This command also updates the `g4f` package at startup and installs any additional dependencies: (x64 and arm64)
|
### Slim Docker image (x64 & arm64)
|
||||||
```bash
|
```bash
|
||||||
mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
|
mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
|
||||||
chown -R 1000:1000 ${PWD}/har_and_cookies ${PWD}/generated_media
|
chown -R 1000:1000 ${PWD}/har_and_cookies ${PWD}/generated_media
|
||||||
|
|
||||||
docker run \
|
docker run \
|
||||||
-p 1337:8080 -p 8080:8080 \
|
-p 1337:8080 -p 8080:8080 \
|
||||||
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
||||||
-v ${PWD}/generated_media:/app/generated_media \
|
-v ${PWD}/generated_media:/app/generated_media \
|
||||||
hlohaus789/g4f:latest-slim
|
hlohaus789/g4f:latest-slim
|
||||||
```
|
```
|
||||||
|
Notes:
|
||||||
|
- The slim image can update the g4f package on startup and installs additional dependencies as needed.
|
||||||
|
- In this example, the Interference API is mapped to 1337.
|
||||||
|
|
||||||
5. **Access the Client Interface:**
|
### Windows Guide (.exe)
|
||||||
- **To use the included client, navigate to:** [http://localhost:8080/chat/](http://localhost:8080/chat/)
|
1. Download the release artifact `g4f.exe.zip` from:
|
||||||
- **Or set the API base for your client to:** [http://localhost:8080/v1](http://localhost:8080/v1)
|
https://github.com/xtekky/gpt4free/releases/latest
|
||||||
|
2. Unzip and run `g4f.exe`.
|
||||||
|
3. Open GUI at: http://localhost:8080/chat/
|
||||||
|
4. If Windows Firewall blocks access, allow the application.
|
||||||
|
|
||||||
6. **(Optional) Provider Login:**
|
### Python Installation (pip / from source / partial installs)
|
||||||
If required, you can access the container's desktop here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret for provider login purposes.
|
|
||||||
|
|
||||||
---
|
Prerequisites:
|
||||||
|
- Python 3.10+ (https://www.python.org/downloads/)
|
||||||
|
- Chrome/Chromium for some providers.
|
||||||
|
|
||||||
### 🪟 Windows Guide (.exe)
|
Install from PyPI (recommended):
|
||||||
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/latest) 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/](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.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 🐍 Python Installation
|
|
||||||
|
|
||||||
#### Prerequisites:
|
|
||||||
1. Install Python 3.10+ from [python.org](https://www.python.org/downloads/).
|
|
||||||
2. Install Google Chrome for certain providers.
|
|
||||||
|
|
||||||
#### Install with PyPI:
|
|
||||||
```bash
|
```bash
|
||||||
pip install -U g4f[all]
|
pip install -U g4f[all]
|
||||||
```
|
```
|
||||||
|
|
||||||
> How do I install only parts or do disable parts? **Use partial requirements:** [/docs/requirements](https://github.com/gpt4free/g4f.dev/blob/main/docs/requirements.md)
|
Partial installs
|
||||||
|
- To install only specific functionality, use optional extras groups. See docs/requirements.md in the project docs.
|
||||||
|
|
||||||
#### Install from Source:
|
Install from source:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/xtekky/gpt4free.git
|
git clone https://github.com/xtekky/gpt4free.git
|
||||||
cd gpt4free
|
cd gpt4free
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
> How do I load the project using git and installing the project requirements? **Read this tutorial and follow it step by step:** [/docs/git](https://github.com/gpt4free/g4f.dev/blob/main/docs/git.md)
|
Notes:
|
||||||
|
- Some features require Chrome/Chromium or other tools; follow provider-specific docs.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 💡 Usage
|
## Running the app
|
||||||
|
|
||||||
### 📝 Text Generation
|
### GUI (web client)
|
||||||
|
- Run via Python:
|
||||||
|
```python
|
||||||
|
from g4f.gui import run_gui
|
||||||
|
run_gui()
|
||||||
|
```
|
||||||
|
- Or via CLI:
|
||||||
|
```bash
|
||||||
|
python -m g4f.cli gui --port 8080 --debug
|
||||||
|
```
|
||||||
|
- Open: http://localhost:8080/chat/
|
||||||
|
|
||||||
|
### FastAPI / Interference API
|
||||||
|
- Start FastAPI server:
|
||||||
|
```bash
|
||||||
|
python -m g4f --port 8080 --debug
|
||||||
|
```
|
||||||
|
- If using slim docker mapping, Interference API may be available at `http://localhost:1337/v1`
|
||||||
|
- Swagger UI: `http://localhost:1337/docs`
|
||||||
|
|
||||||
|
### CLI
|
||||||
|
- Start GUI server:
|
||||||
|
```bash
|
||||||
|
python -m g4f.cli gui --port 8080 --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
### Optional provider login (desktop within container)
|
||||||
|
- Accessible at:
|
||||||
|
```
|
||||||
|
http://localhost:7900/?autoconnect=1&resize=scale&password=secret
|
||||||
|
```
|
||||||
|
- Useful for logging into web-based providers to obtain cookies/HAR files.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Using the Python client
|
||||||
|
|
||||||
|
Install:
|
||||||
|
```bash
|
||||||
|
pip install -U g4f[all]
|
||||||
|
```
|
||||||
|
|
||||||
|
Synchronous text example:
|
||||||
```python
|
```python
|
||||||
from g4f.client import Client
|
from g4f.client import Client
|
||||||
|
|
||||||
client = Client()
|
client = Client()
|
||||||
response = client.chat.completions.create(
|
response = client.chat.completions.create(
|
||||||
model="gpt-4o-mini",
|
model="gpt-4o-mini",
|
||||||
messages=[{"role": "user", "content": "Hello"}],
|
messages=[{"role": "user", "content": "Hello, how are you?"}],
|
||||||
web_search=False
|
web_search=False
|
||||||
)
|
)
|
||||||
print(response.choices[0].message.content)
|
print(response.choices[0].message.content)
|
||||||
```
|
```
|
||||||
|
Expected:
|
||||||
```
|
```
|
||||||
Hello! How can I assist you today?
|
Hello! How can I assist you today?
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🎨 Image Generation
|
Image generation example:
|
||||||
```python
|
```python
|
||||||
from g4f.client import Client
|
from g4f.client import Client
|
||||||
|
|
||||||
|
|
@ -195,266 +243,179 @@ response = client.images.generate(
|
||||||
prompt="a white siamese cat",
|
prompt="a white siamese cat",
|
||||||
response_format="url"
|
response_format="url"
|
||||||
)
|
)
|
||||||
|
|
||||||
print(f"Generated image URL: {response.data[0].url}")
|
print(f"Generated image URL: {response.data[0].url}")
|
||||||
```
|
```
|
||||||
[](https://github.com/gpt4free/g4f.dev/blob/main/docs/client.md)
|
|
||||||
|
|
||||||
### 🧙♂️ Using GPT4Free.js
|
Async client example:
|
||||||
|
```python
|
||||||
|
from g4f.async_client import AsyncClient
|
||||||
|
import asyncio
|
||||||
|
|
||||||
Use the **official JS client** right in the browser—no backend needed.
|
async def main():
|
||||||
|
client = AsyncClient()
|
||||||
|
response = await client.chat.completions.create(
|
||||||
|
model="gpt-4o-mini",
|
||||||
|
messages=[{"role": "user", "content": "Explain quantum computing briefly"}],
|
||||||
|
)
|
||||||
|
print(response.choices[0].message.content)
|
||||||
|
|
||||||
For text generation:
|
asyncio.run(main())
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- See the full API reference for streaming, tool-calling patterns, and advanced options: https://g4f.dev/docs/client
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Using GPT4Free.js (browser JS client)
|
||||||
|
Use the official JS client in the browser—no backend required.
|
||||||
|
|
||||||
|
Example:
|
||||||
```html
|
```html
|
||||||
<script type="module">
|
<script type="module">
|
||||||
import Client from 'https://g4f.dev/dist/js/client.js';
|
import Client from 'https://g4f.dev/dist/js/client.js';
|
||||||
|
|
||||||
const client = new Client();
|
const client = new Client();
|
||||||
const result = await client.chat.completions.create({
|
const result = await client.chat.completions.create({
|
||||||
model: 'gpt-4.1', // Or "gpt-4o", "deepseek-v3"
|
model: 'gpt-4.1', // Or "gpt-4o", "deepseek-v3", etc.
|
||||||
messages: [{ role: 'user', content: 'Explain quantum computing' }]
|
messages: [{ role: 'user', content: 'Explain quantum computing' }]
|
||||||
});
|
});
|
||||||
console.log(result.choices[0].message.content);
|
console.log(result.choices[0].message.content);
|
||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🌐 Web Interface
|
Notes:
|
||||||
**Run the GUI using Python:**
|
- The JS client is distributed via the g4f.dev CDN for easy usage. Review CORS considerations and usage limits.
|
||||||
```python
|
|
||||||
from g4f.gui import run_gui
|
|
||||||
|
|
||||||
run_gui()
|
|
||||||
```
|
|
||||||
**Run via CLI (To start the Flask Server):**
|
|
||||||
```bash
|
|
||||||
python -m g4f.cli gui --port 8080 --debug
|
|
||||||
```
|
|
||||||
**Or, start the FastAPI Server:**
|
|
||||||
```bash
|
|
||||||
python -m g4f --port 8080 --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Learn More About the GUI:** For detailed instructions on how to set up, configure, and use the GPT4Free GUI, refer to the [GUI Documentation](https://github.com/gpt4free/g4f.dev/blob/main/docs/gui.md) . This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 🤖 Interference API
|
## Providers & models (overview)
|
||||||
|
- GPT4Free integrates many providers including (but not limited to) OpenAI-compatible endpoints, PerplexityLabs, Gemini, MetaAI, Pollinations (media), and local inference backends.
|
||||||
|
- Model availability and behavior depend on provider capabilities. See the providers doc for current, supported provider/model lists: https://g4f.dev/docs/providers-and-models
|
||||||
|
|
||||||
The **Interference API** enables seamless integration with OpenAI's services through G4F, allowing you to deploy efficient AI solutions.
|
Provider requirements may include:
|
||||||
|
- API keys or tokens (for authenticated providers)
|
||||||
- **Documentation**: [Interference API Docs](https://github.com/gpt4free/g4f.dev/blob/main/docs/interference-api.md)
|
- Browser cookies / HAR files for providers scraped via browser automation
|
||||||
- **Endpoint**: `http://localhost:1337/v1`
|
- Chrome/Chromium or headless browser tooling
|
||||||
- **Swagger UI**: Explore the OpenAPI documentation via Swagger UI at `http://localhost:1337/docs`
|
- Local model binaries and runtime (for local inference)
|
||||||
- **Provider Selection**: [How to Specify a Provider?](https://github.com/gpt4free/g4f.dev/blob/main/docs/selecting_a_provider.md)
|
|
||||||
|
|
||||||
This API is designed for straightforward implementation and enhanced compatibility with other OpenAI integrations.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 📱 Run on Smartphone
|
## Local inference & media
|
||||||
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](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/phone.md)
|
- GPT4Free supports local inference backends. See [docs/local.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/local.md) for supported runtimes and hardware guidance.
|
||||||
|
- Media generation (image, audio, video) is supported through providers (e.g., Pollinations). See [docs/media.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/media.md) for formats, options, and sample usage.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
#### **📘 Full Documentation for Python API**
|
## Configuration & customization
|
||||||
- **Client API from G4F:** [/docs/client](https://github.com/gpt4free/g4f.dev/blob/main/docs/client.md)
|
- Configure via environment variables, CLI flags, or config files. See [docs/config.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/config.md).
|
||||||
- **AsyncClient API from G4F:** [/docs/async_client](https://github.com/gpt4free/g4f.dev/blob/main/docs/async_client.md)
|
- To reduce install size, use partial requirement groups. See [docs/requirements.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/requirements.md).
|
||||||
- **Requests API from G4F:** [/docs/requests](https://github.com/gpt4free/g4f.dev/blob/main/docs/requests.md)
|
- Provider selection: learn how to set defaults and override per-request at [docs/selecting_a_provider.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/selecting_a_provider.md).
|
||||||
- **File API from G4F:** [/docs/file](https://github.com/gpt4free/g4f.dev/blob/main/docs/file.md)
|
- Persistence: HAR files, cookies, and generated media persist in mapped directories (e.g., har_and_cookies, generated_media).
|
||||||
- **PydanticAI and LangChain Integration for G4F:** [/docs/pydantic_ai](https://github.com/gpt4free/g4f.dev/blob/main/docs/pydantic_ai.md)
|
|
||||||
- **Legacy API with python modules:** [/docs/legacy](https://github.com/gpt4free/g4f.dev/blob/main/docs/legacy.md)
|
|
||||||
- **G4F - Media Documentation (Image, Audio and Video)** [/docs/media](https://github.com/gpt4free/g4f.dev/blob/main/docs/media.md) *(New)*
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Powered by Pollinations AI
|
## Running on smartphone
|
||||||
|
- The web GUI is responsive and can be accessed from a phone by visiting your host IP:8080 or via a tunnel. See [docs/guides/phone.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/phone.md).
|
||||||
**🌟 Pollinations AI**
|
|
||||||
|
|
||||||
<img src="https://image.pollinations.ai/prompt/Create+a+logo+for+Pollinations+AI+featuring+an+abstract+flower+blooming+digital+petals+glowing+center+futuristic+font+Pollinations+AI?width=512&height=256&nologo=true" height="128">
|
|
||||||
|
|
||||||
A creative AI content platform that generates images, audios, and other media using advanced generative models. Pollinations AI empowers users and developers to turn text into visuals and multimedia experiences.
|
|
||||||
|
|
||||||
> [pollinations/pollinations on GitHub](https://github.com/pollinations/pollinations)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Powered by GPT4Free
|
## Interference API (OpenAI‑compatible)
|
||||||
|
- The Interference API enables OpenAI-like workflows routed through GPT4Free provider selection.
|
||||||
|
- Docs: [docs/interference-api.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/interference-api.md)
|
||||||
|
- Default endpoint (example slim docker): `http://localhost:1337/v1`
|
||||||
|
- Swagger UI: `http://localhost:1337/docs`
|
||||||
|
|
||||||
**💸 MoneyPrinter**
|
---
|
||||||
|
|
||||||
<img src="https://image.pollinations.ai/prompt/Create+a+logo+for+MoneyPrinter+glowing+center+futuristic+font?width=512&height=256&nologo=true" height="128">
|
## Examples & common patterns
|
||||||
|
- Streaming completions, stopping criteria, system messages, and tool-calling patterns are documented in:
|
||||||
|
- [docs/client.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/client.md)
|
||||||
|
- [docs/async_client.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/async_client.md)
|
||||||
|
- [docs/requests.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/requests.md)
|
||||||
|
- Integrations (LangChain, PydanticAI): [docs/pydantic_ai.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/pydantic_ai.md)
|
||||||
|
- Legacy examples: [docs/legacy.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/legacy.md)
|
||||||
|
|
||||||
MoneyPrinter V2 cranks up the automation for making money online. It’s a complete overhaul of the original MoneyPrinter, rebuilt from the ground up for more features and a plug-and-play, modular design. MPV2 takes the grind and guesswork out of online income: just set it up, let it run, and watch your earnings stack.
|
---
|
||||||
|
|
||||||
> [FujiwaraChoki/MoneyPrinterV2 on GitHub](https://github.com/FujiwaraChoki/MoneyPrinterV2)
|
## Contributing
|
||||||
|
Contributions are welcome — new providers, features, docs, and fixes are appreciated.
|
||||||
|
|
||||||
> [Full list of GPT4Free powered sites and tools](https://github.com/gpt4free/g4f.dev/blob/main/docs/powered-by.md)
|
How to contribute:
|
||||||
|
1. Fork the repository.
|
||||||
|
2. Create a branch for your change.
|
||||||
|
3. Run tests and linters.
|
||||||
|
4. Open a Pull Request with a clear description and tests/examples if applicable.
|
||||||
|
|
||||||
## 🤝 Contribute
|
Repository: https://github.com/xtekky/gpt4free
|
||||||
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?
|
### How to create a new provider
|
||||||
- **Read:** [Create Provider Guide](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/create_provider.md)
|
- Read the guide: [docs/guides/create_provider.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/create_provider.md)
|
||||||
|
- Typical steps:
|
||||||
|
- Implement a provider adapter in `g4f/Provider/`
|
||||||
|
- Add configuration and dependency notes
|
||||||
|
- Include tests and usage examples
|
||||||
|
- Respect third‑party code licenses and attribute appropriately
|
||||||
|
|
||||||
###### Guide: How can AI help me with writing code?
|
### How AI can help you write code
|
||||||
- **Read:** [AI Assistance Guide](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/help_me.md)
|
- See: [docs/guides/help_me.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/guides/help_me.md) for prompt templates and workflows to accelerate development.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security, privacy & takedown policy
|
||||||
|
- Do not store or share sensitive credentials. Use per-provider recommended security practices.
|
||||||
|
- If your site appears in the project’s links and you want it removed, send proof of ownership to takedown@g4f.ai and it will be removed promptly.
|
||||||
|
- For production, secure the server with HTTPS, authentication, and firewall rules. Limit access to provider credentials and cookie/HAR storage.
|
||||||
|
|
||||||
## Contributors
|
---
|
||||||
A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)
|
|
||||||
|
|
||||||
<a href="https://github.com/xtekky" target="_blank"><img src="https://avatars.githubusercontent.com/u/98614666?v=4&s=45" width="45" title="xtekky"></a>
|
## Credits, contributors & attribution
|
||||||
<a href="https://github.com/hlohaus" target="_blank"><img src="https://avatars.githubusercontent.com/u/983577?v=4&s=45" width="45" title="hlohaus"></a>
|
- Core creators: [@xtekky](https://github.com/xtekky) (original), maintained by [@hlohaus](https://github.com/hlohaus).
|
||||||
<a href="https://github.com/kqlio67" target="_blank"><img src="https://avatars.githubusercontent.com/u/166700875?v=4&s=45" width="45" title="kqlio67"></a>
|
- Full contributor graph: https://github.com/xtekky/gpt4free/graphs/contributors
|
||||||
<a href="https://github.com/bagusindrayana" target="_blank"><img src="https://avatars.githubusercontent.com/u/36830534?v=4&s=45" width="45" title="bagusindrayana"></a>
|
- Notable code inputs and attributions:
|
||||||
<a href="https://github.com/sudouser777" target="_blank"><img src="https://avatars.githubusercontent.com/u/22415463?v=4&s=45" width="45" title="sudouser777"></a>
|
- `har_file.py` — input from [xqdoo00o/ChatGPT-to-API](https://github.com/xqdoo00o/ChatGPT-to-API)
|
||||||
<a href="https://github.com/thatlukinhasguy1" target="_blank"><img src="https://avatars.githubusercontent.com/u/139662282?v=4&s=45" width="45" title="thatlukinhasguy1"></a>
|
- `PerplexityLabs.py` — input from [nathanrchn/perplexityai](https://github.com/nathanrchn/perplexityai)
|
||||||
<a href="https://github.com/Commenter123321" target="_blank"><img src="https://avatars.githubusercontent.com/u/36051603?v=4&s=45" width="45" title="Commenter123321"></a>
|
- `Gemini.py` — input from [dsdanielpark/Gemini-API](https://github.com/dsdanielpark/Gemini-API) and [HanaokaYuzu/Gemini-API](https://github.com/HanaokaYuzu/Gemini-API)
|
||||||
<a href="https://github.com/DanielShemesh" target="_blank"><img src="https://avatars.githubusercontent.com/u/20585236?v=4&s=45" width="45" title="DanielShemesh"></a>
|
- `MetaAI.py` — inspired by [meta-ai-api by Strvm](https://github.com/Strvm/meta-ai-api)
|
||||||
<a href="https://github.com/Luneye" target="_blank"><img src="https://avatars.githubusercontent.com/u/73485421?v=4&s=45" width="45" title="Luneye"></a>
|
- `proofofwork.py` — input from [missuo/FreeGPT35](https://github.com/missuo/FreeGPT35)
|
||||||
<a href="https://github.com/foxfire52" target="_blank"><img src="https://avatars.githubusercontent.com/u/185073927?v=4&s=45" width="45" title="foxfire52"></a>
|
|
||||||
<a href="https://github.com/ezerinz" target="_blank"><img src="https://avatars.githubusercontent.com/u/100193740?v=4&s=45" width="45" title="ezerinz"></a>
|
|
||||||
<a href="https://github.com/enganese" target="_blank"><img src="https://avatars.githubusercontent.com/u/69082498?v=4&s=45" width="45" title="enganese"></a>
|
|
||||||
<a href="https://github.com/Lin-jun-xiang" target="_blank"><img src="https://avatars.githubusercontent.com/u/63782903?v=4&s=45" width="45" title="Lin-jun-xiang"></a>
|
|
||||||
<a href="https://github.com/nullstreak" target="_blank"><img src="https://avatars.githubusercontent.com/u/139914347?v=4&s=45" width="45" title="nullstreak"></a>
|
|
||||||
<a href="https://github.com/valerii-chirkov" target="_blank"><img src="https://avatars.githubusercontent.com/u/81074936?v=4&s=45" width="45" title="valerii-chirkov"></a>
|
|
||||||
<a href="https://github.com/MIDORIBIN" target="_blank"><img src="https://avatars.githubusercontent.com/u/25425217?v=4&s=45" width="45" title="MIDORIBIN"></a>
|
|
||||||
<a href="https://github.com/repollo" target="_blank"><img src="https://avatars.githubusercontent.com/u/2671466?v=4&s=45" width="45" title="repollo"></a>
|
|
||||||
<a href="https://github.com/hpsj" target="_blank"><img src="https://avatars.githubusercontent.com/u/54535414?v=4&s=45" width="45" title="hpsj"></a>
|
|
||||||
<a href="https://github.com/taiyi747" target="_blank"><img src="https://avatars.githubusercontent.com/u/63543716?v=4&s=45" width="45" title="taiyi747"></a>
|
|
||||||
<a href="https://github.com/zukixa" target="_blank"><img src="https://avatars.githubusercontent.com/u/56563509?v=4&s=45" width="45" title="zukixa"></a>
|
|
||||||
<a href="https://github.com/ostix360" target="_blank"><img src="https://avatars.githubusercontent.com/u/55257054?v=4&s=45" width="45" title="ostix360"></a>
|
|
||||||
<a href="https://github.com/WdR-Tech" target="_blank"><img src="https://avatars.githubusercontent.com/u/143020293?v=4&s=45" width="45" title="WdR-Tech"></a>
|
|
||||||
<a href="https://github.com/HexyeDEV" target="_blank"><img src="https://avatars.githubusercontent.com/u/65314629?v=4&s=45" width="45" title="HexyeDEV"></a>
|
|
||||||
<a href="https://github.com/9fo" target="_blank"><img src="https://avatars.githubusercontent.com/u/71867245?v=4&s=45" width="45" title="9fo"></a>
|
|
||||||
<a href="https://github.com/devAdityaa" target="_blank"><img src="https://avatars.githubusercontent.com/u/77636021?v=4&s=45" width="45" title="devAdityaa"></a>
|
|
||||||
<a href="https://github.com/24rr" target="_blank"><img src="https://avatars.githubusercontent.com/u/109844019?v=4&s=45" width="45" title="24rr"></a>
|
|
||||||
<a href="https://github.com/zeng-rr" target="_blank"><img src="https://avatars.githubusercontent.com/u/47846202?v=4&s=45" width="45" title="zeng-rr"></a>
|
|
||||||
<a href="https://github.com/rkihacker" target="_blank"><img src="https://avatars.githubusercontent.com/u/182319878?v=4&s=45" width="45" title="rkihacker"></a>
|
|
||||||
<a href="https://github.com/naa7" target="_blank"><img src="https://avatars.githubusercontent.com/u/44613678?v=4&s=45" width="45" title="naa7"></a>
|
|
||||||
<a href="https://github.com/ramon-victor" target="_blank"><img src="https://avatars.githubusercontent.com/u/13617054?v=4&s=45" width="45" title="ramon-victor"></a>
|
|
||||||
<a href="https://github.com/eltociear" target="_blank"><img src="https://avatars.githubusercontent.com/u/22633385?v=4&s=45" width="45" title="eltociear"></a>
|
|
||||||
<a href="https://github.com/kggn" target="_blank"><img src="https://avatars.githubusercontent.com/u/95663228?v=4&s=45" width="45" title="kggn"></a>
|
|
||||||
<a href="https://github.com/xiangsx" target="_blank"><img src="https://avatars.githubusercontent.com/u/29322721?v=4&s=45" width="45" title="xiangsx"></a>
|
|
||||||
<a href="https://github.com/ggindinson" target="_blank"><img src="https://avatars.githubusercontent.com/u/97807772?v=4&s=45" width="45" title="ggindinson"></a>
|
|
||||||
<a href="https://github.com/ahobsonsayers" target="_blank"><img src="https://avatars.githubusercontent.com/u/32173585?v=4&s=45" width="45" title="ahobsonsayers"></a>
|
|
||||||
<a href="https://github.com/mache102" target="_blank"><img src="https://avatars.githubusercontent.com/u/91365155?v=4&s=45" width="45" title="mache102"></a>
|
|
||||||
<a href="https://github.com/kogakisaki" target="_blank"><img src="https://avatars.githubusercontent.com/u/95165750?v=4&s=45" width="45" title="kogakisaki"></a>
|
|
||||||
<a href="https://github.com/Andrew-Tsegaye" target="_blank"><img src="https://avatars.githubusercontent.com/u/91322467?v=4&s=45" width="45" title="Andrew-Tsegaye"></a>
|
|
||||||
<a href="https://github.com/omidima" target="_blank"><img src="https://avatars.githubusercontent.com/u/47784584?v=4&s=45" width="45" title="omidima"></a>
|
|
||||||
<a href="https://github.com/nonk123" target="_blank"><img src="https://avatars.githubusercontent.com/u/43842467?v=4&s=45" width="45" title="nonk123"></a>
|
|
||||||
<a href="https://github.com/MaxKUlish1" target="_blank"><img src="https://avatars.githubusercontent.com/u/93388714?v=4&s=45" width="45" title="MaxKUlish1"></a>
|
|
||||||
<a href="https://github.com/AymaneHrouch" target="_blank"><img src="https://avatars.githubusercontent.com/u/36491424?v=4&s=45" width="45" title="AymaneHrouch"></a>
|
|
||||||
<a href="https://github.com/Eikosa" target="_blank"><img src="https://avatars.githubusercontent.com/u/20538090?v=4&s=45" width="45" title="Eikosa"></a>
|
|
||||||
<a href="https://github.com/localagi" target="_blank"><img src="https://avatars.githubusercontent.com/u/132956819?v=4&s=45" width="45" title="localagi"></a>
|
|
||||||
<a href="https://github.com/thebigbone" target="_blank"><img src="https://avatars.githubusercontent.com/u/95130644?v=4&s=45" width="45" title="thebigbone"></a>
|
|
||||||
<a href="https://github.com/kailust" target="_blank"><img src="https://avatars.githubusercontent.com/u/82623773?v=4&s=45" width="45" title="kailust"></a>
|
|
||||||
<a href="https://github.com/ading2210" target="_blank"><img src="https://avatars.githubusercontent.com/u/71154407?v=4&s=45" width="45" title="ading2210"></a>
|
|
||||||
<a href="https://github.com/Zero6992" target="_blank"><img src="https://avatars.githubusercontent.com/u/89479282?v=4&s=45" width="45" title="Zero6992"></a>
|
|
||||||
<a href="https://github.com/mishl-dev" target="_blank"><img src="https://avatars.githubusercontent.com/u/91066601?v=4&s=45" width="45" title="mishl-dev"></a>
|
|
||||||
<a href="https://github.com/ElonGaties" target="_blank"><img src="https://avatars.githubusercontent.com/u/59313695?v=4&s=45" width="45" title="ElonGaties"></a>
|
|
||||||
<a href="https://github.com/TotoB12" target="_blank"><img src="https://avatars.githubusercontent.com/u/91705868?v=4&s=45" width="45" title="TotoB12"></a>
|
|
||||||
<a href="https://github.com/malivinayak" target="_blank"><img src="https://avatars.githubusercontent.com/u/66154908?v=4&s=45" width="45" title="malivinayak"></a>
|
|
||||||
<a href="https://github.com/Zedai00" target="_blank"><img src="https://avatars.githubusercontent.com/u/33319711?v=4&s=45" width="45" title="Zedai00"></a>
|
|
||||||
<a href="https://github.com/catmeowjiao" target="_blank"><img src="https://avatars.githubusercontent.com/u/138079152?v=4&s=45" width="45" title="catmeowjiao"></a>
|
|
||||||
<a href="https://github.com/cifer-sudo" target="_blank"><img src="https://avatars.githubusercontent.com/u/60644739?v=4&s=45" width="45" title="cifer-sudo"></a>
|
|
||||||
<a href="https://github.com/eminemkun" target="_blank"><img src="https://avatars.githubusercontent.com/u/49590289?v=4&s=45" width="45" title="eminemkun"></a>
|
|
||||||
<a href="https://github.com/kafmws" target="_blank"><img src="https://avatars.githubusercontent.com/u/33590879?v=4&s=45" width="45" title="kafmws"></a>
|
|
||||||
<a href="https://github.com/najam-tariq" target="_blank"><img src="https://avatars.githubusercontent.com/u/103676132?v=4&s=45" width="45" title="najam-tariq"></a>
|
|
||||||
<a href="https://github.com/ochen1" target="_blank"><img src="https://avatars.githubusercontent.com/u/59662605?v=4&s=45" width="45" title="ochen1"></a>
|
|
||||||
<a href="https://github.com/r1di" target="_blank"><img src="https://avatars.githubusercontent.com/u/33724815?v=4&s=45" width="45" title="r1di"></a>
|
|
||||||
<a href="https://github.com/sagadav" target="_blank"><img src="https://avatars.githubusercontent.com/u/42406802?v=4&s=45" width="45" title="sagadav"></a>
|
|
||||||
<a href="https://github.com/snyk-bot" target="_blank"><img src="https://avatars.githubusercontent.com/u/19733683?v=4&s=45" width="45" title="snyk-bot"></a>
|
|
||||||
<a href="https://github.com/vatva691" target="_blank"><img src="https://avatars.githubusercontent.com/u/30290559?v=4&s=45" width="45" title="vatva691"></a>
|
|
||||||
<a href="https://github.com/Qustelm" target="_blank"><img src="https://avatars.githubusercontent.com/u/83110161?v=4&s=45" width="45" title="Qustelm"></a>
|
|
||||||
<a href="https://github.com/HyiKi" target="_blank"><img src="https://avatars.githubusercontent.com/u/55942998?v=4&s=45" width="45" title="HyiKi"></a>
|
|
||||||
<a href="https://github.com/0dminnimda" target="_blank"><img src="https://avatars.githubusercontent.com/u/52697657?v=4&s=45" width="45" title="0dminnimda"></a>
|
|
||||||
<a href="https://github.com/Akash98Sky" target="_blank"><img src="https://avatars.githubusercontent.com/u/37451227?v=4&s=45" width="45" title="Akash98Sky"></a>
|
|
||||||
<a href="https://github.com/adeyinkaezra123" target="_blank"><img src="https://avatars.githubusercontent.com/u/65364356?v=4&s=45" width="45" title="adeyinkaezra123"></a>
|
|
||||||
<a href="https://github.com/Giancarlo-Ma" target="_blank"><img src="https://avatars.githubusercontent.com/u/65126107?v=4&s=45" width="45" title="Giancarlo-Ma"></a>
|
|
||||||
<a href="https://github.com/gran4" target="_blank"><img src="https://avatars.githubusercontent.com/u/80655391?v=4&s=45" width="45" title="gran4"></a>
|
|
||||||
<a href="https://github.com/guspan-tanadi" target="_blank"><img src="https://avatars.githubusercontent.com/u/36249910?v=4&s=45" width="45" title="guspan-tanadi"></a>
|
|
||||||
<a href="https://github.com/oubrax" target="_blank"><img src="https://avatars.githubusercontent.com/u/72103863?v=4&s=45" width="45" title="oubrax"></a>
|
|
||||||
<a href="https://github.com/hansipie" target="_blank"><img src="https://avatars.githubusercontent.com/u/5460714?v=4&s=45" width="45" title="hansipie"></a>
|
|
||||||
<a href="https://github.com/GetTuh" target="_blank"><img src="https://avatars.githubusercontent.com/u/27581581?v=4&s=45" width="45" title="GetTuh"></a>
|
|
||||||
<a href="https://github.com/kushal34712" target="_blank"><img src="https://avatars.githubusercontent.com/u/98145879?v=4&s=45" width="45" title="kushal34712"></a>
|
|
||||||
<a href="https://github.com/Fubge" target="_blank"><img src="https://avatars.githubusercontent.com/u/115476150?v=4&s=45" width="45" title="Fubge"></a>
|
|
||||||
<a href="https://github.com/Niapoll" target="_blank"><img src="https://avatars.githubusercontent.com/u/64135936?v=4&s=45" width="45" title="Niapoll"></a>
|
|
||||||
<a href="https://github.com/OmiiiDev" target="_blank"><img src="https://avatars.githubusercontent.com/u/103533638?v=4&s=45" width="45" title="OmiiiDev"></a>
|
|
||||||
<a href="https://github.com/RasyiidWho" target="_blank"><img src="https://avatars.githubusercontent.com/u/19422415?v=4&s=45" width="45" title="RasyiidWho"></a>
|
|
||||||
<a href="https://github.com/RavenOwO" target="_blank"><img src="https://avatars.githubusercontent.com/u/118295106?v=4&s=45" width="45" title="RavenOwO"></a>
|
|
||||||
<a href="https://github.com/anonymousx97" target="_blank"><img src="https://avatars.githubusercontent.com/u/88324835?v=4&s=45" width="45" title="anonymousx97"></a>
|
|
||||||
<a href="https://github.com/krjordan" target="_blank"><img src="https://avatars.githubusercontent.com/u/10234150?v=4&s=45" width="45" title="krjordan"></a>
|
|
||||||
<a href="https://github.com/SilverMarcs" target="_blank"><img src="https://avatars.githubusercontent.com/u/77480421?v=4&s=45" width="45" title="SilverMarcs"></a>
|
|
||||||
<a href="https://github.com/Yusufibin" target="_blank"><img src="https://avatars.githubusercontent.com/u/71589435?v=4&s=45" width="45" title="Yusufibin"></a>
|
|
||||||
<a href="https://github.com/yuri-val" target="_blank"><img src="https://avatars.githubusercontent.com/u/15129796?v=4&s=45" width="45" title="yuri-val"></a>
|
|
||||||
<a href="https://github.com/yousefnegmeldin" target="_blank"><img src="https://avatars.githubusercontent.com/u/96620955?v=4&s=45" width="45" title="yousefnegmeldin"></a>
|
|
||||||
<a href="https://github.com/perklet" target="_blank"><img src="https://avatars.githubusercontent.com/u/1035487?v=4&s=45" width="45" title="perklet"></a>
|
|
||||||
<a href="https://github.com/varshney-yash" target="_blank"><img src="https://avatars.githubusercontent.com/u/107148830?v=4&s=45" width="45" title="varshney-yash"></a>
|
|
||||||
<a href="https://github.com/Yoxmo" target="_blank"><img src="https://avatars.githubusercontent.com/u/94254616?v=4&s=45" width="45" title="Yoxmo"></a>
|
|
||||||
<a href="https://github.com/yjg30737" target="_blank"><img src="https://avatars.githubusercontent.com/u/55078043?v=4&s=45" width="45" title="yjg30737"></a>
|
|
||||||
<a href="https://github.com/williamstein" target="_blank"><img src="https://avatars.githubusercontent.com/u/1276278?v=4&s=45" width="45" title="williamstein"></a>
|
|
||||||
<a href="https://github.com/ZachKLYeh" target="_blank"><img src="https://avatars.githubusercontent.com/u/105150034?v=4&s=45" width="45" title="ZachKLYeh"></a>
|
|
||||||
<a href="https://github.com/alvarosoaress" target="_blank"><img src="https://avatars.githubusercontent.com/u/13721147?v=4&s=45" width="45" title="alvarosoaress"></a>
|
|
||||||
<a href="https://github.com/bruvv" target="_blank"><img src="https://avatars.githubusercontent.com/u/3063928?v=4&s=45" width="45" title="bruvv"></a>
|
|
||||||
<a href="https://github.com/carlinhoshk" target="_blank"><img src="https://avatars.githubusercontent.com/u/40872405?v=4&s=45" width="45" title="carlinhoshk"></a>
|
|
||||||
<a href="https://github.com/cckuailong" target="_blank"><img src="https://avatars.githubusercontent.com/u/10824150?v=4&s=45" width="45" title="cckuailong"></a>
|
|
||||||
<a href="https://github.com/chinmay7016" target="_blank"><img src="https://avatars.githubusercontent.com/u/75988613?v=4&s=45" width="45" title="chinmay7016"></a>
|
|
||||||
<a href="https://github.com/diaodeng" target="_blank"><img src="https://avatars.githubusercontent.com/u/108243171?v=4&s=45" width="45" title="diaodeng"></a>
|
|
||||||
<a href="https://github.com/monosans" target="_blank"><img src="https://avatars.githubusercontent.com/u/76561516?v=4&s=45" width="45" title="monosans"></a>
|
|
||||||
<a href="https://github.com/Ayushpanditmoto" target="_blank"><img src="https://avatars.githubusercontent.com/u/31253617?v=4&s=45" width="45" title="Ayushpanditmoto"></a>
|
|
||||||
<span></span>
|
|
||||||
<img src="https://avatars.githubusercontent.com/u/71154407?s=45&v=4" width="45" title="ading2210">
|
|
||||||
<img src="https://avatars.githubusercontent.com/u/12299238?s=45&v=4" width="45" title="xqdoo00o">
|
|
||||||
<img src="https://avatars.githubusercontent.com/u/97126670?s=45&v=4" width="45" title="nathanrchn">
|
|
||||||
<img src="https://avatars.githubusercontent.com/u/81407603?v=4&s=45" width="45" title="dsdanielpark">
|
|
||||||
<img src="https://avatars.githubusercontent.com/u/55200481?v=4&s=45" width="45" title="missuo">
|
|
||||||
|
|
||||||
- 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)
|
Many more contributors are acknowledged in the repository.
|
||||||
- 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)
|
|
||||||
- The [`Gemini.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/needs_auth/Gemini.py) has input from [HanaokaYuzu/Gemini-API](https://github.com/HanaokaYuzu/Gemini-API)
|
|
||||||
|
|
||||||
_Having input implies that the AI's code generation utilized it as one of many sources._
|
---
|
||||||
|
|
||||||
## ⭐ Star History
|
## Powered-by highlights
|
||||||
|
- Pollinations AI — generative media: https://github.com/pollinations/pollinations
|
||||||
|
- MoneyPrinter V2 — example project using GPT4Free: https://github.com/FujiwaraChoki/MoneyPrinterV2
|
||||||
|
- For a full list of projects and sites using GPT4Free, see: [docs/powered-by.md](https://github.com/gpt4free/g4f.dev/blob/main/docs/powered-by.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
> [!IMPORTANT]
|
## Changelog & releases
|
||||||
> **GPT4Free Manifesto**
|
- Releases and full changelog: https://github.com/xtekky/gpt4free/releases
|
||||||
|
- Subscribe to Discord/Telegram for announcements.
|
||||||
|
|
||||||
We live in a time where access to information and technology is increasingly restricted. Large corporations seek to monopolize control over their models, subjecting essential resources to strict terms of service and opaque practices. But we are here to stand against this tide.
|
---
|
||||||
|
|
||||||
We declare:
|
## Manifesto / Project principles
|
||||||
|
GPT4Free is guided by community principles:
|
||||||
|
1. Open access to AI tooling and models.
|
||||||
|
2. Collaboration across providers and projects.
|
||||||
|
3. Opposition to monopolistic, closed systems that restrict creativity.
|
||||||
|
4. Community-centered development and broad access to AI technologies.
|
||||||
|
5. Promote innovation, creativity, and accessibility.
|
||||||
|
|
||||||
1. **Open Access:** Developing software and utilizing AI models is not illegal. It is a basic right that belongs to everyone. The notion that developing or using AI for purposes outside of what large companies dictate constitutes a legal violation is not only incorrect, but it is also an attack on creativity and innovation.
|
https://g4f.dev/manifest
|
||||||
|
|
||||||
2. **Collaboration Over Isolation:** Instead of monopolizing a platform through enclosure, we should connect various models together. Only through collaboration can we make the benefits of AI accessible to all and foster diversity and progress.
|
---
|
||||||
|
|
||||||
3. **Against Privatization:** The privatization and isolation of models by large companies is not only dishonest but also unethical. It hinders progress and innovation while restricting developers' and users' opportunities. We rise against this form of market dominance.
|
## License
|
||||||
|
This program is licensed under the GNU General Public License v3.0 (GPLv3). See the full license: https://www.gnu.org/licenses/gpl-3.0.txt
|
||||||
|
|
||||||
4. **For the Community:** Let’s build a community that promotes the free exchange of ideas and technologies. An effective and just system must reflect the diversity of voices and perspectives.
|
Summary:
|
||||||
|
- You may redistribute and/or modify under the terms of GPLv3.
|
||||||
5. **Unleashing Creativity:** We firmly believe that the true value of AI lies in its ability to solve problems, support, and inspire. Let us not be held back by restrictive practices.
|
- The program is provided WITHOUT ANY WARRANTY.
|
||||||
|
|
||||||
In this spirit, we proclaim: The future of AI does not belong to a few giant corporations; it belongs to each and every one of us. Let’s work together to create a space where innovation can flourish, and where everyone has access to the tools they need to express themselves and grow.
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> Together, we will shape an open, inclusive, and more just digital world. 🤗
|
|
||||||
|
|
||||||
## 🔻 Site Takedown
|
|
||||||
|
|
||||||
Is your site on this repository and you want to take it down? Send an email to takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. 😉
|
|
||||||
|
|
||||||
## ©️ Copyright
|
|
||||||
|
|
||||||
This program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
||||||
|
|
||||||
|
Copyright notice
|
||||||
```
|
```
|
||||||
xtekky/gpt4free: Copyright (C) 2025 xtekky
|
xtekky/gpt4free: Copyright (C) 2025 xtekky
|
||||||
|
|
||||||
|
|
@ -467,25 +428,62 @@ This program is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
GNU General Public License for more details.
|
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 <https://www.gnu.org/licenses/>.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 📄 License
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<p align="center"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/93/GPLv3_Logo.svg/1200px-GPLv3_Logo.svg.png" width="120"></img>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<img src="https://img.shields.io/badge/License-GNU_GPL_v3.0-red.svg"/> <br>
|
|
||||||
This project is licensed under <a href="https://github.com/xtekky/gpt4free/blob/main/LICENSE">GNU_GPL_v3.0</a>.
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<p align="right">(<a href="#top">🔼 Back to top</a>)</p>
|
## Contact & sponsorship
|
||||||
|
- Maintainers: https://github.com/hlohaus
|
||||||
|
- Sponsorship: https://github.com/sponsors/hlohaus
|
||||||
|
- Issues & feature requests: https://github.com/xtekky/gpt4free/issues
|
||||||
|
- Takedown requests: takedown@g4f.ai
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Appendix: Quick commands & examples
|
||||||
|
|
||||||
|
Install (pip):
|
||||||
|
```bash
|
||||||
|
pip install -U g4f[all]
|
||||||
|
```
|
||||||
|
|
||||||
|
Run GUI (Python):
|
||||||
|
```bash
|
||||||
|
python -m g4f.cli gui --port 8080 --debug
|
||||||
|
# or
|
||||||
|
python -c "from g4f.gui import run_gui; run_gui()"
|
||||||
|
```
|
||||||
|
|
||||||
|
Docker (full):
|
||||||
|
```bash
|
||||||
|
docker pull hlohaus789/g4f
|
||||||
|
docker run -p 8080:8080 -p 7900:7900 \
|
||||||
|
--shm-size="2g" \
|
||||||
|
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
||||||
|
-v ${PWD}/generated_media:/app/generated_media \
|
||||||
|
hlohaus789/g4f:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Docker (slim):
|
||||||
|
```bash
|
||||||
|
docker run -p 1337:8080 -p 8080:8080 \
|
||||||
|
-v ${PWD}/har_and_cookies:/app/har_and_cookies \
|
||||||
|
-v ${PWD}/generated_media:/app/generated_media \
|
||||||
|
hlohaus789/g4f:latest-slim
|
||||||
|
```
|
||||||
|
|
||||||
|
Python usage patterns:
|
||||||
|
- `client.chat.completions.create(...)`
|
||||||
|
- `client.images.generate(...)`
|
||||||
|
- Async variants via `AsyncClient`
|
||||||
|
|
||||||
|
Docs & deeper reading
|
||||||
|
- Full docs: https://g4f.dev/docs
|
||||||
|
- Client API docs: https://g4f.dev/docs/client
|
||||||
|
- Async client docs: https://g4f.dev/docs/async_client
|
||||||
|
- Provider guides: https://g4f.dev/docs/guides
|
||||||
|
- Local inference: https://g4f.dev/docs/local
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Thank you for using and contributing to GPT4Free — together we make powerful AI tooling accessible, flexible, and community-driven.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue