Repository files navigation

Written by@xtekky

pip install -U g4f[all]

docker pull hlohaus789/g4f

• Explore the latest features and updates
  Find comprehensive details on ourReleases Page.

• Stay updated with our Telegram Channel 📨
  Join us attelegram.me/g4f_channel.

• Subscribe to our Discord News Channel 💬🆕️
  Stay informed about updates via ourNews Channel: discord.gg/5E39JUWUFa.

• Get support in our Discord Community 🤝💻
  Reach out for help in ourSupport Group: discord.gg/qXA4Wf4Fsm.

• Read our Documentation 📖
  Find detailed guidance and resources atg4f.dev/docs.

Is your site on this repository and you want to take it down? Send an email totakedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. 😉

Want to see G4F in action? Explore a live demo now!

Curious to see what G4F can do? Dive into a live demonstration and visit theofficial g4f.dev homepage for more.

• 🆕 What's New
• 📚 Table of Contents
• ⚡ Getting Started
  • 🛠 Installation
    • 🐳 Using Docker
    • 🪟 Windows Guide (.exe)
    • 🐍 Python Installation
• 💡 Usage
  • 📝 Text Generation
  • 🎨 Image Generation
  • 🌐 Web Interface
  • 🖥️ Local Inference
  • 🤖 Inference API
  • 🛠️ Configuration
  • 📱 Run on Smartphone
  • 📘 Full Documentation for Python API
• 🚀 Providers and Models
• 🔗 Powered by gpt4free
• 🤝 Contribute
  • How do i create a new Provider?
  • How can AI help me with writing code?
• 🙌 Contributors
• ©️ Copyright
• ⭐ Star History
• 📄 License

1. Install Docker:Download and install 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:

mkdir -p${PWD}/har_and_cookies${PWD}/generated_mediasudo 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):

docker pull hlohaus789/g4fdocker 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

4. Running the Slim Docker Image: And use the following commands to run the Slim Docker image. This command also updates theg4f package at startup and installs any additional dependencies: (x64 and arm64)

mkdir -p${PWD}/har_and_cookies${PWD}/generated_mediachown -R 1000:1000${PWD}/har_and_cookies${PWD}/generated_mediadocker 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

5. Access the Client Interface:

   • To use the included client, navigate to:http://localhost:8080/chat/
   • Or set the API base for your client to: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.

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 ourreleases page and download the most recent version of the application, namedg4f.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 theg4f.exe file to run the app.
3. Open GUI: The app starts a web server with the GUI. Open your favorite browser and navigate tohttp://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.

1. Install Python 3.10+ frompython.org.
2. Install Google Chrome for certain providers.

pip install -U g4f[all]

How do I install only parts or do disable parts?Use partial requirements:/docs/requirements

git clone https://github.com/xtekky/gpt4free.gitcd gpt4freepip 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

fromg4f.clientimportClientclient=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?

fromg4f.clientimportClientclient=Client()response=client.images.generate(model="flux",prompt="a white siamese cat",response_format="url")print(f"Generated image URL:{response.data[0].url}")

Run the GUI using Python:

fromg4f.guiimportrun_guirun_gui()

Run via CLI (To start the Flask Server):

python -m g4f.cli gui --port 8080 --debug

Or, start the FastAPI Server:

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 theGUI Documentation . This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.

TheInference API enables seamless integration with OpenAI's services through G4F, allowing you to deploy efficient AI solutions.

• Documentation:Inference API Docs
• Endpoint:http://localhost:1337/v1
• Swagger UI: Explore the OpenAPI documentation via Swagger UI athttp://localhost:1337/docs
• Provider Selection:How to Specify a Provider?

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

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

• Client API from G4F:/docs/client
• AsyncClient API from G4F:/docs/async_client
• Requests API from G4F:/docs/requests
• File API from G4F:/docs/file
• PydanticAI and LangChain Integration for G4F:/docs/pydantic_ai
• Legacy API with python modules:/docs/legacy
• G4F - Media Documentation (Image, Audio and Video)/docs/media(New)

🌟 Pollinations AI

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

💸 MoneyPrinter

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

Full list of GPT4Free powered sites and tools

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.

• Read:Create Provider Guide

• Read:AI Assistance Guide

A list of all contributors is availablehere

• TheVercel.py file contains code fromvercel-llm-api by@ading2210
• Thehar_file.py has input fromxqdoo00o/ChatGPT-to-API
• ThePerplexityLabs.py has input fromnathanrchn/perplexityai
• TheGemini.py has input fromdsdanielpark/Gemini-API
• TheMetaAI.py file contains code frommeta-ai-api by@Strvm
• Theproofofwork.py has input frommissuo/FreeGPT35
• TheGemini.py has input fromHanaokaYuzu/Gemini-API

Having input implies that the AI's code generation utilized it as one of many sources.

This program is licensed under theGNU GPL v3

xtekky/gpt4free: Copyright (C) 2023 xtekkyThis program is free software: you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See theGNU General Public License for more details.You should have received a copy of the GNU General Public Licensealong with this program.  If not, see <https://www.gnu.org/licenses/>.

This project is licensed underGNU_GPL_v3.0.

(🔼 Back to top)