Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 12 hours ago
JSON representation

The official gpt4free repository | various collection of powerful language models

Awesome Lists containing this project

README 

        
xtekky%2Fgpt4free | Trendshift



---





  

    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:
 [![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[all]

```



```sh

docker pull hlohaus789/g4f

```



## ๐Ÿ†• 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).



## ๐Ÿ”ป 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. ๐Ÿ˜‰



## ๐Ÿš€ GPT4Free on HuggingFace

[![HuggingSpace](https://github.com/user-attachments/assets/1d859e8a-d6fa-416f-a213-ccc26aa11e90)](https://huggingface.co/spaces/roxky/g4f-space)

**Is a proof-of-concept API package for multi-provider AI requests. It showcases features such as:**



- Load balancing and request flow control.

- Seamless integration with multiple AI providers.

- Comprehensive text and image generation support.



> Explore the [Visit GPT4Free on HuggingFace Space](https://huggingface.co/spaces/roxky/g4f-space) for a hosted version or [Duplicate GPT4Free Space](https://huggingface.co/spaces/roxky/g4f-space?duplicate=true) it for personal use.



---



## ๐Ÿ“š Table of Contents

   - [๐Ÿ†• What's New](#-whats-new)

   - [๐Ÿ“š Table of Contents](#-table-of-contents)

   - [โšก Getting Started](#-getting-started)

      - [๐Ÿ›  Installation](#-installation)

         - [๐Ÿณ Using Docker](#-using-docker)

         - [๐ŸชŸ Windows Guide (.exe)](#-windows-guide-exe)

         - [๐Ÿ Python Installation](#-python-installation)

  - [๐Ÿ’ก Usage](#-usage)

     - [๐Ÿ“ Text Generation](#-text-generation)

     - [๐ŸŽจ Image Generation](#-image-generation)

     - [๐ŸŒ Web Interface](#-web-interface)

     - [๐Ÿ–ฅ๏ธ Local Inference](docs/local.md)

     - [๐Ÿค– Interference API](#-interference-api)

     - [๐Ÿ› ๏ธ Configuration](docs/configuration.md)

     - [๐Ÿ“ฑ Run on Smartphone](#-run-on-smartphone)

     - [๐Ÿ“˜ Full Documentation for Python API](#-full-documentation-for-python-api)

  - [๐Ÿš€ 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



## ๐Ÿ›  Installation



### ๐Ÿณ Using Docker

1. **Install Docker:** [Download and install Docker](https://docs.docker.com/get-docker/).

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: 

```bash

   mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_images

   sudo chown -R 1200:1201 ${PWD}/har_and_cookies ${PWD}/generated_images

```

3. **Run the Docker Container:** Use the following commands to pull the latest image and start the container (Only x64):

```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_images:/app/generated_images \

     hlohaus789/g4f:latest

```



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)

```bash

  mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_images

  chown -R 1000:1000 ${PWD}/har_and_cookies ${PWD}/generated_images

	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

```

 

5. **Access the Client Interface:**

   - **To use the included client, navigate to:** [http://localhost:8080/chat/](http://localhost:8080/chat/)

   - **Or set the API base for your client to:** [http://localhost:8080/v1](http://localhost:8080/v1)



6. **(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.



---



### ๐ŸชŸ Windows Guide (.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.4.2.0) 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

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:

```bash

git clone https://github.com/xtekky/gpt4free.git

cd gpt4free

pip install -r requirements.txt

```



> 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)



---



## ๐Ÿ’ก 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"}],

    web_search=False

)

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"

)



print(f"Generated image URL: {response.data[0].url}")

```

[![Image with cat](/docs/images/cat.jpeg)](docs/client.md)



### ๐ŸŒ Web Interface

**Run the GUI using Python:**

```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](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



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`

- **Provider Selection**: [How to Specify a Provider?](docs/selecting_a_provider.md)



This API is designed for straightforward implementation and enhanced compatibility with other OpenAI integrations.



---



### ๐Ÿ“ฑ Run on 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)



---



#### **๐Ÿ“˜ Full Documentation for Python API**

   - **Client API from G4F:** [/docs/client](docs/client.md)

   - **AsyncClient API from G4F:** [/docs/async_client](docs/async_client.md)

   - **Requests API from G4F:** [/docs/requests](docs/requests.md)

   - **File API from G4F:** [/docs/file](docs/file.md)

   - **Legacy API with python modules:** [/docs/legacy](docs/legacy.md)

      

---



## ๐Ÿ”— Powered by gpt4free



  

    

      

        ๐ŸŽ Projects

      

      

        โญ Stars

      

      

        ๐Ÿ“š Forks

      

      

        ๐Ÿ›Ž Issues

      

      

        ๐Ÿ“ฌ Pull requests

      

    

  

  

    

      

        

          gpt4free

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        gpt4free-ts

      

    

    

      

        Stars

      

    

    

      

        Forks

      

    

    

      

        Issues

      

    

    

      

        Pull Requests

      

    

    

    

      

        

          Free AI API's & Potential Providers List

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

    

      

        

          ChatGPT-Clone

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          Ai agent

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          ChatGpt Discord Bot

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          chatGPT-discord-bot

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

      

        

          Nyx-Bot (Discord)

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

    

      

        

          LangChain gpt4free

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          ChatGpt Telegram Bot

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          ChatGpt Line Bot

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          Action Translate Readme

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          Langchain Document GPT

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          python-tgpt

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          GPT4js

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

    

      

        

          VividNode (pyqt-openai)

        

      

      

        

          Stars

        

      

      

        

          Forks

        

      

      

        

          Issues

        

      

      

        

          Pull Requests

        

      

    

  



## ๐Ÿค 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





        Star History Chart




## ๐Ÿ“„ License



  

     

       
 

    


     

       
 

This project is licensed under GNU_GPL_v3.0.

    

  



---



(๐Ÿ”ผ Back to top)