Your first flightInstall OwnPilot, connect a model, and give your assistant its first task.InstallationDocker, source development, prerequisites and first-run checks.A system you can understandFollow a request from your interface through the gateway to models, tools and storage.Meet your working crewChat agents, Claw runtimes, Soul identities and multi-agent crews.Give your AI useful handsBuilt-in tools, MCP servers, extensions, skills and your own CLI tools.Your choice of intelligenceCloud providers, aggregators, local models and routing strategies.From a request to a routineVisual workflows, scheduled tasks, triggers, plans and proactive autonomy.Talk where you already areWeb chat, Telegram, WhatsApp, voice and real-time feedback.A memory for your working lifeNotes, tasks, goals, contacts, custom tables and persistent memory.Ownership, with clear boundariesData flow, authentication, tool approvals, isolation and deployment responsibilities.Make it your ownEnvironment variables, Config Center, model settings and safe defaults.Give OwnPilot a reliable homeVolumes, HTTPS, authentication, backups and upgrading a self-hosted instance.Build around the gatewayHTTP APIs, streamed responses, WebSocket events and MCP.
THE OWNPILOT FIELD GUIDE

Build around the gateway

HTTP APIs, streamed responses, WebSocket events and MCP.

OwnPilot v0.8.3 · Source-verified guide

A programmatic assistant

The gateway exposes REST endpoints for conversations, agents, personal data, tools, configuration and other product features. The README’s API Reference is the authoritative entry point for paths and request shapes at your product version.

Streaming and events

Server-Sent Events stream model responses and tool execution progress. WebSockets support data updates, event subscriptions and session handling. The EventBus bridge translates internal event naming into the WebSocket conventions.

Start with a health check

For a local default deployment, query the gateway health endpoint. This checks service availability; it does not prove that a provider or an agent is configured.

Gateway health
curl http://localhost:8080/health

Authenticate your client

Configure the selected API-key or JWT mode and use its documented client flow. Keep credentials on a trusted client and apply least privilege to exposed tools. For tool-oriented integrations, consider the MCP server instead of custom HTTP plumbing.

FOLLOW THE SOURCE

Based on the product’s documented behavior. Check the source for your deployed version.

Product README