privateGPT

---
Running a model locally is only the first step. To build useful AI applications you need a set of higher-level building blocks. PrivateGPT provides that layer as an open-source API following the Claude API model — so you can build private AI products without rebuilding the same backend primitives from scratch, and without depending on cloud APIs.
Production-tested: PrivateGPT powers Zylon, the on-premise AI platform providing Private AI to enterprises across the globe.
> PrivateGPT does **not** run models itself. It connects to any OpenAI-compatible inference server via OPENAI_API_BASE. If it implements /v1/chat/completions and /v1/models, it works.
PrivateGPT ships a built-in workbench UI for testing and demos, available at /ui. The API is the actual product.
---
What PrivateGPT gives you
- Standard messages API (streaming, async, token counting)
- File and artifact ingestion
- Retrieval with citations and agentic RAG
- Built-in tools mirroring the Claude API (web search, web fetch, code execution)
- Custom tools and MCP connectors
- Structured access to databases and CSVs
- Embeddings and orchestration
---
Quickstart
> For Docker, full installation options, and model configuration see the full Quickstart guide.
**Prerequisites:** You need a running OpenAI-compatible LLM server. Ollama is the easiest starting point.
**1. Install PrivateGPT**
**2. Start your LLM server**
**3. Run PrivateGPT**
**4. Open the UI**
Go to http://localhost:8080/ui. The API is at http://localhost:8080 and follows the Anthropic API spec.
The UI is useful for:
- Sending messages.
- Selecting models from /v1/models.
- Uploading documents.
- Testing retrieval with citations.
- Enabling tools per chat.
- Configuring databases, MCP connectors, skills, and custom tools.
- Inspecting requests and responses through the API Debugger.
This UI is a demonstrator, not the core product. Developers are expected to build their own applications on top of the API. That said, the UI is intentionally polished enough for demos, videos, internal pilots, and quick local usage.
---
Integrations
| | | |
|:-------------------------:|:-------------------------:|:-------------------------:|
| **Claude Desktop / Cowork**| **Microsoft Excel Claude add-in**| **Microsoft Word Claude add-in**|
| **n8n**| **OpenCode**| **PrivateGPT Workbench**|
PrivateGPT works natively as the local backend for the tools developers and end users already use.
| Integration Guide | What it enables |
|---|---|
| **Claude Code** | Use your local models as the backend for agentic coding in the terminal |
| **Claude Desktop / Cowork** | Connect the Claude desktop app and Cowork to your private models |
| **Claude for Microsoft 365** | Run private AI inside Word, Excel, Outlook, and PowerPoint |
| **OpenCode** | Local AI coding assistant in the terminal |
Any tool that works with a local OpenAI-compatible provider will also work with PrivateGPT. The list below is non-exhaustive.
| Tool | Link |
|---|---|
| n8n | n8n.io |
| OpenClaw | openclaw.ai |
| Hermes Agent | hermes-agent.dev |
| VS Code | code.visualstudio.com |
| Cline | cline.bot |
---
Claude API compatibility
PrivateGPT follows the Claude API as the reference for modern AI application APIs. The goal is full coverage where it makes sense for a local, open-source layer.
| Area | Capability | Claude API | PrivateGPT |
|---|---|:---:|:---:|
| Models | Model selection | ✅ | ✅ |
| Messages | Messages API | ✅ | ✅ |
| Messages | Streaming | ✅ | ✅ |