This guide assumes you have completed the Quickstart and have GAIA installed.
Getting Started
Prerequisites
The Agent UI requires two backend services:- Lemonade Server — serves the LLM locally (port 8000)
- A downloaded model — the LLM the agent uses to reason
Using the npm install?
gaia-ui handles prerequisite #1 and #2 automatically on first run (installs Lemonade Server and downloads a minimal model). You can skip to Install and Launch.--profile minimal for a smaller download (~400 MB).
Then start the server:
Install and Launch
Choose one of the two install paths:- npm (Recommended)
- Python CLI
The npm package bundles everything — on first run it auto-installs the Python backend (uv, Python 3.12, amd-gaia), Lemonade Server, and a minimal model.Requires: Node.js 18+ (Then launch:The Agent UI opens automatically in your browser at http://localhost:4200.Options:
Update:
winget install OpenJS.NodeJS.LTS on Windows, brew install node@20 on macOS)| Flag | Description |
|---|---|
gaia-ui --port 8080 | Custom port |
gaia-ui --no-open | Don’t auto-open the browser |
gaia-ui --serve | Serve frontend only (Node.js static server) |
gaia-ui --version | Show version |
What You Can Do
Search and Browse Files
The agent has access to your local file system. Ask it to find files, explore directories, or locate specific content across your projects — no manual browsing required.Analyze Documents
Once the agent finds files — or you drag them into a session — it can index and analyze their content. Ask it to summarize, compare, extract data, or answer questions about any supported format:- Documents: PDF, Word, PowerPoint, Excel, TXT, Markdown, CSV, JSON, HTML, XML, YAML
- Code: Python, JavaScript, TypeScript, Java, C/C++, Go, Rust, Ruby, Shell
- Config: INI, CFG, TOML, YAML, JSON, XML
Session Management
Create, rename, search, export (Markdown/JSON), and delete sessions. Sessions persist across the CLI (gaia chat) and the Agent UI.
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
Enter | Send task / message |
Shift+Enter | New line |
Escape | Stop agent response |
Ctrl+K | Focus sidebar search |
MCP Server
The Agent UI includes a built-in MCP (Model Context Protocol) server that exposes the full Agent UI as a set of tools. This lets external AI assistants — like Claude Code, Cursor, or any MCP-compatible client — interact with GAIA agents through the same backend that powers the web UI. Conversations initiated via MCP appear in the browser UI in real time, so you can watch tool execution and agent activity as it happens. The MCP server provides 15 tools for managing sessions, sending messages, indexing documents, browsing files, and more. See the Agent UI MCP Server guide for setup instructions and usage examples.Troubleshooting
Lemonade Server not running
Lemonade Server not running
Start Lemonade with
lemonade-server serve. If Lemonade is not installed, follow the initialization steps in the Quickstart.No model loaded
No model loaded
Download models with
gaia init --profile chat. See the Quickstart for details.Port 4200 already in use
Port 4200 already in use
Database locked error
Database locked error
Close any other GAIA Agent UI or CLI instances. Only one writer at a time is supported.
Document indexing fails
Document indexing fails
- Ensure the file is a supported format and not password-protected
- Keep file size under 100MB
- For PDF image extraction, download the VLM model:
gaia download --agent chat
Frontend shows JSON instead of the UI
Frontend shows JSON instead of the UI
The Agent UI frontend has not been built.npm install (Then restart
gaia-ui): This is handled automatically — gaia-ui tells the Python server where to find the pre-built frontend. If you still see this error, try reinstalling: npm install -g @amd-gaia/agent-ui@latest Then restart with gaia-ui.Source/dev installs (git clone): Run gaia init to build it automatically, or manually (from the repo root):gaia chat --ui.pip/PyPI installs (without gaia-ui): Use the npm install path — the pip package does not include frontend source files.Architecture
For the REST API reference and backend classes, see the Agent UI SDK Reference.Next Steps
Agent UI SDK Reference
REST endpoints, database schema, and Python backend API
Document Q&A Agent
CLI-based document agent with RAG, debug mode, and chunking strategies
Build Your First Agent
Create a custom agent with tools in minutes
MCP Server
Connect Claude Code, Cursor, or any MCP client to the Agent UI