README.md

---
title: FreeLLMAPI Cloud Proxy
emoji: 🔌
colorFrom: indigo
colorTo: purple
sdk: docker
app_port: 7860
pinned: false
short_description: FreeLLMAPI — one OpenAI-compatible endpoint
tags:
  - llm
  - openai-compatible
  - proxy
  - freellmapi
---

# FreeLLMAPI — Cloud Proxy on Hugging Face Spaces

This Space runs [tashfeenahmed/freellmapi](https://github.com/tashfeenahmed/freellmapi) from the prebuilt image
`ghcr.io/tashfeenahmed/freellmapi:latest` — **no local clone, no local disk used**.

- Dashboard + API on port `7860` (HF requirement)
- SQLite DB at `/data/freellmapi.db` (ephemeral — see persistence note)
- Secrets (`ENCRYPTION_KEY`, admin config) are set in **Space → Settings → Variables and secrets**, never committed here.

## Endpoints

- Dashboard: `https://<your-space>.hf.space/`
- Health: `https://<your-space>.hf.space/api/ping`
- OpenAI-compatible: `https://<your-space>.hf.space/v1/chat/completions`

```bash
curl https://<your-space>.hf.space/v1/chat/completions \
  -H "Authorization: Bearer freellmapi-YOUR-UNIFIED-KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"auto","messages":[{"role":"user","content":"Say hello from FreeLLMAPI."}]}'
```

## First-run setup

1. Open the Space URL, create the first dashboard account (or pre-create via `FREEAPI_CONFIG_JSON`, see below).
2. Go to **Keys** page → add provider keys → reorder **Fallback Chain**.
3. Copy your unified `freellmapi-...` key from the Keys page header → point any OpenAI SDK at the Space URL.