GPT4Free (g4f)

---

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.

This README is a consolidated, improved, and complete guide to installing, running, and contributing to GPT4Free.

Table of contents

• What’s included
• Quick links
• Requirements & compatibility
• Installation
  • Docker (recommended)
  • Slim Docker image
  • Sandbox desktop (Docker)
  • Windows (.exe)
  • Python (pip / from source / partial installs)
• Running the app
  • GUI (web client)
  • FastAPI / Inference API
  • CLI
  • Optional provider login (desktop in container)
• Using the Python client
  • Synchronous text example
  • Image generation example
  • Async client example
• Using GPT4Free.js (browser JS client)
• Providers & models (overview)
• Local inference & media
• Configuration & customization
• Running on smartphone
• Inference API (OpenAI‑compatible)
• Examples & common patterns
• Contributing
  • How to create a new provider
  • How AI can help you write code
• Security, privacy & takedown policy
• Credits, contributors & attribution
• Powered-by highlights
• Changelog & releases
• Manifesto / Project principles
• License
• Contact & sponsorship
• Appendix: Quick commands & examples

---

What’s included

• Python client library and async client.
• Optional local web GUI.
• FastAPI-based OpenAI-compatible API (Inference 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.

---

Quick links

• Website & docs: https://g4f.dev | https://g4f.dev/docs
• 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)

---

Related projects

• g4f-go – Self-contained Go launcher for g4f (downloads CPython + g4f on demand; includes the g4f-go sandbox launcher for Docker, Podman and udocker)
• remote_desktop – WebRTC-based remote desktop host/viewer
• sandbox-desktop – TigerVNC + Xfce + noVNC desktop in Docker with preinstalled coding agents (menu/tool list, start script, Dockerfile)

---

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

     mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
     sudo chown -R 1200:1201 ${PWD}/har_and_cookies ${PWD}/generated_media
     

3. Pull image:

   docker pull hlohaus789/g4f
   

4. Run container:

   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
   

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.

This is the beginning of the README. Read the rest at the original. Read the full README ↗