Quick Start (Self-host)
This guide gets you from zero to a working AI agent in under 5 minutes. Make sure you have SynapseOrch installed first.
Not installed yet? Start with Installation.
Step 1 — Configure a LLM provider
Open SynapseOrch with the link the installer printed at the end — Synapse is running → http://localhost:3000/?token=…, which synapse start prints too. With login off it carries the access link's token, and synapse access-link prints it again.
If you chose an AI while installing, it is already set up — go straight to Step 2. Otherwise the app opens on Connect a model, which finds the model tools on this computer and takes a key (what it shows); or go to Settings → Models yourself.
Using Ollama (no API key required)
- Install Ollama if you haven't already
- Pull a model:
ollama pull mistral - In Settings → Models, the Ollama (Local) card lists the models it found. Set Default model to
ollama.mistral— an install that skipped the AI question already uses it — and click Save changes
Until Ollama answers with the default model, Chat's welcome line says Model not ready and why, with a link back to Settings → Models.
Using Claude, GPT or another hosted model
- Click the provider's card — Anthropic Claude, OpenAI, Google Gemini, xAI Grok or DeepSeek — paste your API key and click the card's Save
- Set Default model — e.g.
claude-opus-5orgpt-4o - Click Save changes
See Cloud Providers and Local Providers for every option.
The screens, step by step: Install on your computer, in the Guides.
Step 2 — Create an agent
- Open Agents and press New agent
- Fill in:
- Name — e.g.
Research Agent - Agent Type — Conversational
- Tools — enable Web Scraper, or Browser Automation, to start
- Instructions — e.g.
You are a helpful research assistant. When given a topic, search the web and provide a concise summary with key facts.
- Name — e.g.
- Click Save
Step 3 — Chat with your agent
- Open Chat and pick your agent from its name at the foot of the message box
- Type a message:
What is the Model Context Protocol and how does it work? - Watch the agent reason through the problem, call tools if needed, and return a response
What's next?
| Topic | Description |
|---|---|
| Guides | Build real things step by step, on one example workspace |
| Agents | Learn about agent types, tools, memory, and system prompts |
| Workflows | Build multi-step workflows |
| Tools | Explore the built-in tools available to agents |
| Apps (MCP servers) | Connect GitHub, Jira, Zapier, and more |
| API Reference | Drive SynapseOrch from your own code |
| Docker | Run SynapseOrch in a container |