Setup guides

Plug FreeTheAi into your favorite client.

One key, one base URL, every model. Pick your client below and follow the exact steps. All guides use https://api.freetheai.xyz/v1.

Popular paths

Start from what you are trying to connect.

These pages group the setup guides by client type, so you can jump straight to the right base URL, route, and model setup.

Coding agents

6 guides

VSCode and JetBrains extensions, native editors, and pair-programming agents that talk to FreeTheAi over the OpenAI-compatible API.

Roleplay & chat frontends

4 guides

Roleplay and chat frontends that point to FreeTheAi as a reverse proxy.

General chat clients

10 guides

General-purpose chat clients and self-hosted ChatGPT-style web UIs.

LibreChat

Self-hosted multi-model chat UI.

LibreChat exposes any OpenAI-compatible host through `endpoints.custom`. Add a FreeTheAi block, set the env var, and the model picker auto-fills from /v1/models.

View setup →

Open WebUI

Self-hosted ChatGPT-style UI with native OpenAI connections.

Open WebUI lets admins add multiple OpenAI-compatible connections. Add FreeTheAi and the model picker auto-fills from /v1/models.

View setup →

LobeChat

Modern open-source web chat UI.

LobeChat supports any OpenAI-compatible host through env vars or its `Add Custom Provider` UI. Pair it with FreeTheAi for a slick local web client.

View setup →

AnythingLLM

Self-hosted RAG and chat workspace.

AnythingLLM treats FreeTheAi as a `Generic OpenAI` provider. Type the alias, set the context window, save.

View setup →

Cherry Studio

Cross-platform desktop chat client.

Cherry Studio supports many providers through one UI. Add FreeTheAi as an OpenAI provider and load the aliases you want as separate models.

View setup →

TypingMind

Polished BYOK web frontend.

TypingMind lets you paste any OpenAI-compatible endpoint as a custom model. Add FreeTheAi and use any alias.

View setup →

BoltAI

Native macOS AI assistant in any app.

BoltAI floats AI in any macOS app. Add FreeTheAi as a custom OpenAI-compatible server.

View setup →

Page Assist

Browser extension for AI while you browse.

Page Assist runs in the browser side panel. Add FreeTheAi as a custom OpenAI-compatible API and pick the alias you want.

View setup →

Chatbox

Cross-platform desktop and mobile chat client.

Chatbox supports any OpenAI-compatible base. Use the OpenAI API Compatible mode and split the URL into Host and Path.

View setup →

Big-AGI

Open-source web AI workbench for power users.

Big-AGI's OpenAI vendor accepts a custom API endpoint. Drop FreeTheAi in and Big-AGI auto-fetches /v1/models.

View setup →
CLI & scripting

2 guides

Command-line tools and scripts that use the OpenAI SDK or curl directly.

Don't see your client?

Most OpenAI-compatible clients work out of the box.

FreeTheAi follows the OpenAI Chat Completions, Anthropic Messages, and OpenAI Responses formats. Anything that lets you set a custom base URL and API key works. Use https://api.freetheai.xyz/v1 as the base URL and pick any alias from the model catalog.