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
  • Windows (.exe)
  • Python (pip / from source / partial installs)
• Running the app
  • GUI (web client)
  • FastAPI / Interference 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
• Interference API (OpenAI‑compatible)
• Examples & common patterns

---

What’s included

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

---

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.

Slim Docker image (x64 & arm64)

mkdir -p ${PWD}/har_and_cookies ${PWD}/generated_media
chown -R 1000:1000 ${PWD}/har_and_cookies ${PWD}/generated_media

docker 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

Notes:

• The slim image can update the g4f package on startup and installs additional dependencies as needed.
• In this example, the Interference API is mapped to 1337.

Windows Guide (.exe)

👉 Check out the Windows launcher for GPT4Free:
🔗 https://github.com/gpt4free/g4f.exe 🚀

1. Download the release artifact g4f.exe.zip from: https://github.com/xtekky/gpt4free/releases/latest
2. Unzip and run g4f.exe.
3. Open GUI at: http://localhost:8080/chat/
4. If Windows Firewall blocks access, allow the application.

Python Installation (pip / from source / partial installs)

Prerequisites:

• Python 3.10+ (https://www.python.org/downloads/)
• Chrome/Chromium for some providers.

Install from PyPI (recommended):

pip install -U g4f[all]

Partial installs

• To install only specific functionality, use optional extras groups. See docs/requirements.md in the project docs.

Install from source:

git clone https://github.com/xtekky/gpt4free.git
cd gpt4free
pip install -r requirements.txt
pip install -e .

Notes:

• Some features require Chrome/Chromium or other tools; follow provider-specific docs.

---

Running the app

GUI (web client)

• Run via Python:

from g4f.gui import run_gui
run_gui()

• Or via CLI:

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

• Open: http://localhost:8080/chat/

FastAPI / Interference API

• Start FastAPI server:

python -m g4f --port 8080 --debug

• If using slim docker mapping, Interference API may be available at http://localhost:1337/v1
• Swagger UI: http://localhost:1337/docs

CLI

• Start GUI server:

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

MCP Server

GPT4Free now includes a Model Context Protocol (MCP) server that allows AI assistants like Claude to access web search, scraping, and image generation capabilities.

Starting the MCP server (stdio mode):

# Using g4f command
g4f mcp

# Or using Python module
python -m g4f.mcp

Starting the MCP server (HTTP mode):

# Start HTTP server on port 8765
g4f mcp --http --port 8765

# Custom host and port
g4f mcp --http --host 127.0.0.1 --port 3000

HTTP mode provides:

• POST http://localhost:8765/mcp - JSON-RPC endpoint
• GET http://localhost:8765/health - Health check

Configuring with Claude Desktop:

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "gpt4free": {
      "command": "python",
      "args": ["-m", "g4f.mcp"]
    }
  }
}

Available MCP Tools:

• web_search - Search the web using DuckDuckGo
• web_scrape - Extract text content from web pages
• image_generation - Generate images from text prompts

For detailed MCP documentation, see g4f/mcp/README.md

Optional provider login (desktop within container)

• Accessible at:

  http://localhost:7900/?autoconnect=1&resize=scale&password=secret
  

• Useful for logging into web-based providers to obtain cookies/HAR files.

---

Using the Python client

Install:

pip install -U g4f[all]

Synchronous text example:

from g4f.client import Client

client = Client()
response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello, how are you?"}],
    web_search=False
)
print(response.choices[0].message.content)

Expected:

Hello! How can I assist you today?

Image generation example:

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

Async client example:

from g4f.client import AsyncClient
import asyncio

async def main():
    client = AsyncClient()
    response = await client.chat.completions.create(
        model="gpt-4o-mini",
        messages=[{"role": "user", "content": "Explain quantum computing briefly"}],
    )
    print(response.choices[0].message.content)

asyncio.run(main())

Notes:

• See the full API reference for streaming, tool-calling patterns, and advanced options: https://g4f.dev/docs/client

---

Using GPT4Free.js (browser JS client)

Use the official JS client in the browser—no backend required.

Example:

<script type="module">
  import Client from 'https://g4f.dev/dist/js/client.js';

  const client = new Client();
  const result = await client.chat.completions.create({
      model: 'gpt-4.1',  // Or "gpt-4o", "deepseek-v3", etc.
      messages: [{ role: 'user', content: 'Explain quantum computing' }]
  });
  console.log(result.choices[0].message.content);
</script>

Notes:

• The JS client is distributed via the g4f.dev CDN for easy usage. Review CORS considerations and usage limits.

---

Providers & models (overview)

• GPT4Free integrates many providers including (but not limited to) OpenAI-compatible endpoints, PerplexityLabs, Gemini, MetaAI, Pollinations (media), and local inference backends.
• Model availability and behavior depend on provider capabilities. See the providers doc for current, supported provider/model lists: https://g4f.dev/docs/providers-and-models

Provider requirements may include:

• API keys or tokens (for authenticated providers)
• Browser cookies / HAR files for providers scraped via browser automation
• Chrome/Chromium or headless browser tooling
• Local model binaries and runtime (for local inference)

---

Local inference & media

• GPT4Free supports local inference backends. See docs/local.md for supported runtimes and hardware