![248433934-7886223b-c1d1-4260-82aa-da5741f303bb](https://github.com/xtekky/gpt4free/assets/98614666/ea012c87-76e0-496a-8ac4-e2de090cc6c9)
Written by [@xtekky](https://github.com/hlohaus) & maintained by [@hlohaus](https://github.com/hlohaus)
> 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]
Lastet version: [![PyPI version](https://img.shields.io/pypi/v/g4f?color=blue)](https://pypi.org/project/g4f) [![Docker version](https://img.shields.io/docker/v/hlohaus789/g4f?label=docker&color=blue)](https://hub.docker.com/r/hlohaus789/g4f)
> Stats: [![Downloads](https://static.pepy.tech/badge/g4f)](https://pepy.tech/project/g4f) [![Downloads](https://static.pepy.tech/badge/g4f/month)](https://pepy.tech/project/g4f)
```sh
pip install -U g4f
```
```sh
docker pull hlohaus789/g4f
```
## đ What's New
- Check out a more in depth local inference @ https://github.com/gpt4free/gpt4local
- Join our Telegram Channel: [t.me/g4f_channel](https://telegram.me/g4f_channel)
- Join our Discord Group: [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5)
- `g4f` now supports 100% local inference: [local-docs](https://g4f.mintlify.app/docs/core/usage/local)
## đģ 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 ;)
## đ Feedback and Todo
You can always leave some feedback here: https://forms.gle/FeWV9RLEedfdkmFN6
As per the survey, here is a list of improvements to come
- [x] Update the repository to include the new openai library syntax (ex: `Openai()` class) | completed, use `g4f.client.Client`
- [ ] Golang implementation
- [ ] đ§ Improve Documentation (in /docs & Guides, Howtos, & Do video tutorials)
- [x] Improve the provider status list & updates
- [ ] Tutorials on how to reverse sites to write your own wrapper (PoC only ofc)
- [ ] Improve the Bing wrapper. (might write a new wrapper in golang as it is very fast)
- [ ] Write a standard provider performance test to improve the stability
- [ ] Potential support and development of local models
- [ ] đ§ Improve compatibility and error handling
## đ Table of Contents
- [đ What's New](#-whats-new)
- [đ Table of Contents](#-table-of-contents)
- [đ ī¸ Getting Started](#-getting-started)
+ [Docker container](#docker-container)
- [Quick start](#quick-start)
+ [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)
* [Configuration](#configuration)
- [đ Providers and Models](#-providers-and-models)
* [GPT-4](#gpt-4)
* [GPT-3.5](#gpt-35)
* [Other](#other)
* [Models](#models)
- [đ Related GPT4Free Projects](#-related-gpt4free-projects)
- [đ¤ 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
##### Quick start:
1. [Download and install Docker](https://docs.docker.com/get-docker/)
2. Pull latest image and run the container:
```sh
docker pull hlohaus789/g4f
docker run -p 8080:8080 -p 1337:1337 -p 7900:7900 --shm-size="2g" hlohaus789/g4f:latest
```
3. Open the included client on: [http://localhost:8080/chat/](http://localhost:8080/chat/)
or set the API base in your client to: [http://localhost:1337/v1](http://localhost:1337/v1)
4. (Optional) If you need to log in to a provider, you can view the desktop from the container here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret.
##### Use your smartphone:
Run the Web UI on Your Smartphone:
- [/docs/guides/phone](/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-3.5-turbo",
messages=[{"role": "user", "content": "Hello"}],
...
)
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="gemini",
prompt="a white siamese cat",
...
)
image_url = response.data[0].url
```
[![Image with cat](/docs/cat.jpeg)](/docs/client.md)
**Full Documentation for Python API**
- New Client API like the OpenAI Python library: [/docs/client](/docs/client.md)
- 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
You can use the Interference API to serve other OpenAI integrations with G4F.
See: [/docs/interference](/docs/interference.md)
### Configuration
##### Cookies / Access Token
For generating images with Bing and for the OpenAI Chat you need cookies or a token from your browser session. From Bing you need the "_U" cookie and from OpenAI you need the "access_token". You can pass the cookies / the access token in the create function or you use the `set_cookies` setter before you run G4F:
```python
from g4f.cookies import set_cookies
set_cookies(".bing.com", {
"_U": "cookie value"
})
set_cookies("chat.openai.com", {
"access_token": "token value"
})
set_cookies(".google.com", {
"__Secure-1PSID": "cookie value"
})
...
```
Alternatively, G4F reads the cookies with `browser_cookie3` from your browser
or it starts a browser instance with selenium `webdriver` for logging in.
##### 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
```
## đ Providers and Models
### GPT-4
| Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
| ------ | ------- | ------- | ----- | ------ | ------ | ---- |
| [bing.com](https://bing.com/chat) | `g4f.Provider.Bing` | â | âī¸ | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [chatgpt.ai](https://chatgpt.ai) | `g4f.Provider.ChatgptAi` | â | âī¸ | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [liaobots.site](https://liaobots.site) | `g4f.Provider.Liaobots` | âī¸ | âī¸ | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [chat.openai.com](https://chat.openai.com) | `g4f.Provider.OpenaiChat` | âī¸ | âī¸ | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | âī¸ |
| [raycast.com](https://raycast.com) | `g4f.Provider.Raycast` | âī¸ | âī¸ | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | âī¸ |
| [beta.theb.ai](https://beta.theb.ai) | `g4f.Provider.Theb` | âī¸ | âī¸ | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [you.com](https://you.com) | `g4f.Provider.You` | âī¸ | âī¸ | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
### GPT-3.5
| Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
| ------ | ------- | ------- | ----- | ------ | ------ | ---- |
| [chat3.aiyunos.top](https://chat3.aiyunos.top/) | `g4f.Provider.AItianhuSpace` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [chatforai.store](https://chatforai.store) | `g4f.Provider.ChatForAi` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [chatgpt4online.org](https://chatgpt4online.org) | `g4f.Provider.Chatgpt4Online` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [chatgpt-free.cc](https://www.chatgpt-free.cc) | `g4f.Provider.ChatgptNext` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [chatgptx.de](https://chatgptx.de) | `g4f.Provider.ChatgptX` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [flowgpt.com](https://flowgpt.com/chat) | `g4f.Provider.FlowGpt` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [freegptsnav.aifree.site](https://freegptsnav.aifree.site) | `g4f.Provider.FreeGpt` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [gpttalk.ru](https://gpttalk.ru) | `g4f.Provider.GptTalkRu` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [koala.sh](https://koala.sh) | `g4f.Provider.Koala` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [app.myshell.ai](https://app.myshell.ai/chat) | `g4f.Provider.MyShell` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [perplexity.ai](https://www.perplexity.ai) | `g4f.Provider.PerplexityAi` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [poe.com](https://poe.com) | `g4f.Provider.Poe` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | âī¸ |
| [talkai.info](https://talkai.info) | `g4f.Provider.TalkAi` | âī¸ | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [chat.vercel.ai](https://chat.vercel.ai) | `g4f.Provider.Vercel` | âī¸ | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [aitianhu.com](https://www.aitianhu.com) | `g4f.Provider.AItianhu` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chatgpt.bestim.org](https://chatgpt.bestim.org) | `g4f.Provider.Bestim` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chatbase.co](https://www.chatbase.co) | `g4f.Provider.ChatBase` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chatgptdemo.info](https://chatgptdemo.info/chat) | `g4f.Provider.ChatgptDemo` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chat.chatgptdemo.ai](https://chat.chatgptdemo.ai) | `g4f.Provider.ChatgptDemoAi` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chatgptfree.ai](https://chatgptfree.ai) | `g4f.Provider.ChatgptFree` | âī¸ | â | â | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chatgptlogin.ai](https://chatgptlogin.ai) | `g4f.Provider.ChatgptLogin` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [chat.3211000.xyz](https://chat.3211000.xyz) | `g4f.Provider.Chatxyz` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [gpt6.ai](https://gpt6.ai) | `g4f.Provider.Gpt6` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [gptchatly.com](https://gptchatly.com) | `g4f.Provider.GptChatly` | âī¸ | â | â | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [ai18.gptforlove.com](https://ai18.gptforlove.com) | `g4f.Provider.GptForLove` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [gptgo.ai](https://gptgo.ai) | `g4f.Provider.GptGo` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [gptgod.site](https://gptgod.site) | `g4f.Provider.GptGod` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
| [onlinegpt.org](https://onlinegpt.org) | `g4f.Provider.OnlineGpt` | âī¸ | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | â |
### Other
| Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
| ------ | ------- | ------- | ----- | ------ | ------ | ---- |
| [openchat.team](https://openchat.team) | `g4f.Provider.Aura` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [bard.google.com](https://bard.google.com) | `g4f.Provider.Bard` | â | â | â | ![Unknown](https://img.shields.io/badge/Unknown-grey) | âī¸ |
| [deepinfra.com](https://deepinfra.com) | `g4f.Provider.DeepInfra` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [free.chatgpt.org.uk](https://free.chatgpt.org.uk) | `g4f.Provider.FreeChatgpt` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [gemini.google.com](https://gemini.google.com) | `g4f.Provider.Gemini` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | âī¸ |
| [ai.google.dev](https://ai.google.dev) | `g4f.Provider.GeminiPro` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | âī¸ |
| [gemini-chatbot-sigma.vercel.app](https://gemini-chatbot-sigma.vercel.app) | `g4f.Provider.GeminiProChat` | â | â | âī¸ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | â |
| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingChat` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingFace` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [llama2.ai](https://www.llama2.ai) | `g4f.Provider.Llama2` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [labs.perplexity.ai](https://labs.perplexity.ai) | `g4f.Provider.PerplexityLabs` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [pi.ai](https://pi.ai/talk) | `g4f.Provider.Pi` | â | â | âī¸ | ![Active](https://img.shields.io/badge/Active-brightgreen) | â |
| [theb.ai](https://theb.ai) | `g4f.Provider.ThebApi` | â | â | â | ![Unknown](https://img.shields.io/badge/Unknown-grey) | âī¸ |
| [open-assistant.io](https://open-assistant.io/chat) | `g4f.Provider.OpenAssistant` | â | â | âī¸ | ![Inactive](https://img.shields.io/badge/Inactive-red) | âī¸ |
### Models
| Model | Base Provider | Provider | Website |
| ----- | ------------- | -------- | ------- |
| gpt-3.5-turbo | OpenAI | 5+ Providers | [openai.com](https://openai.com/) |
| gpt-4 | OpenAI | 2+ Providers | [openai.com](https://openai.com/) |
| gpt-4-turbo | OpenAI | g4f.Provider.Bing | [openai.com](https://openai.com/) |
| Llama-2-7b-chat-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) |
| Llama-2-13b-chat-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) |
| Llama-2-70b-chat-hf | Meta | 3+ Providers | [llama.meta.com](https://llama.meta.com/) |
| CodeLlama-34b-Instruct-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) |
| CodeLlama-70b-Instruct-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) |
| Mixtral-8x7B-Instruct-v0.1 | Huggingface | 4+ Providers | [huggingface.co](https://huggingface.co/) |
| Mistral-7B-Instruct-v0.1 | Huggingface | 4+ Providers | [huggingface.co](https://huggingface.co/) |
| dolphin-2.6-mixtral-8x7b | Huggingface | g4f.Provider.DeepInfra | [huggingface.co](https://huggingface.co/) |
| lzlv_70b_fp16_hf | Huggingface | g4f.Provider.DeepInfra | [huggingface.co](https://huggingface.co/) |
| airoboros-70b | Huggingface | g4f.Provider.DeepInfra | [huggingface.co](https://huggingface.co/) |
| airoboros-l2-70b-gpt4-1.4.1 | Huggingface | g4f.Provider.DeepInfra | [huggingface.co](https://huggingface.co/) |
| openchat_3.5 | Huggingface | 2+ Providers | [huggingface.co](https://huggingface.co/) |
| gemini | Google | g4f.Provider.Gemini | [gemini.google.com](https://gemini.google.com/) |
| gemini-pro | Google | 2+ Providers | [gemini.google.com](https://gemini.google.com/) |
| claude-v2 | Anthropic | 1+ Providers | [anthropic.com](https://www.anthropic.com/) |
| claude-3-opus | Anthropic | g4f.Provider.You | [anthropic.com](https://www.anthropic.com/) |
| claude-3-sonnet | Anthropic | g4f.Provider.You | [anthropic.com](https://www.anthropic.com/) |
| pi | Inflection | g4f.Provider.Pi | [inflection.ai](https://inflection.ai/) |
## đ Related GPT4Free Projects
## đ¤ 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: [/docs/guides/create_provider](/docs/guides/create_provider.md)
###### Guide: How can AI help me with writing code?
- Read: [/docs/guides/help_me](/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), which is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
Top 1 Contributor: [@hlohaus](https://github.com/hlohaus)
## Šī¸ 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
(đŧ Back to top)