Build around the gateway
HTTP APIs, streamed responses, WebSocket events and MCP.
OwnPilot v0.8.3 · Source-verified guideA 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.
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.
Based on the product’s documented behavior. Check the source for your deployed version.
Product README