README

GPT4Free (g4f)

    !GitHub Repo stars


  


  




  
    Created by @xtekky, maintained by @hlohaus
  


Support the project on
      
        GitHub Sponsors
      
      ❤️


Live demo & docs: https://g4f.dev | Documentation: https://g4f.dev/docs


---

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.
- Goo

Top issues

Discussions

Latest release

Full Changelog: https://github.com/xtekky/gpt4free/compare/v8.9.1...v8.9.2
 Download Options

Python Package:
- PyPI: pip install g4f==v8.9.2

Executables (g4f-go, self-contained with embedded Python):
- Windows amd64: g4f-go-v8.9.2-windows-amd64.zip
- Linux x64: g4f-go-v8.9.2-linux-amd64.zip
- Linux ARM64: g4f-go-v8.9.2-linux-arm64.zip
- macOS x64: g4f-go-v8.9.2-darwin-amd64.zip
- macOS ARM64: g4f-go-v8.9.2-darwin-arm64.zip
- FreeBSD amd64: g4f-go-v8.9.2-freebsd-amd64.zip

Standalone sandbox launcher (Docker/Podman, image pulled on demand):
- Windows amd64/arm64: g4f-sandbox-v8.9.2-windows-.z