Open Agent API

Documentation Map

Welcome to the Open Agent API documentation. If you are setting up your first gateway, start with the Five-Minute Quickstart and the copy-and-run Cookbook.


Getting started

  • End-to-end walkthrough (publish an agent → issue a key → call via SDK): quickstart.md (or see README, "Running in three minutes")
  • Platform installers & clean uninstall steps (macOS / Windows / Linux desktop app, Linux one-liner, Docker, npm tarball): install.md
  • Tour of the web console (Overview, #workbench, Run Inspector timeline, Webhooks, and Developer Platform): console.md
  • CLI command reference grouped by task (gateway lifecycle, connecting agents, terminal approvals, keys, live verification): cli.md
  • Running on Windows: windows.md
  • Local configuration files and background daemon details: operations.md, "Local start"

Calling agents & orchestrating work

  • Copy-and-run code recipes (cURL plus Python & Node examples for OpenAI, Anthropic, and Gemini SDKs): Cookbook
  • Smart model routing (@fast / @best / @eco), plan-only recommend mode, multi-agent pipelines, and local evaluations: Intelligent Agent API
  • Shared project memory (SQLite FTS5), durable runs, visual DAG workflows (Cron & Webhook triggers), and streaming media artifacts: Persistent Agent Workstation
  • One-click wiring into local IDEs and clients (API providers for OpenCode / Codex / DSH and MCP bridges for Cursor / Windsurf / Claude Desktop / Claude Code): Local Connections
  • Token usage tracking, per-key budgets, and upstream quota snapshots: Usage & Quotas
  • Invoking via the OpenAI SDK, native oaa/1, and cross-agent handoffs: operations.md, "Publish and invoke"
  • Wire protocol reference, file uploads, streaming events, approvals, resume, and cancellation: protocol.md, "Compatibility" and "Execution and actions"
  • Guaranteed JSON Schema structured output (native pushdown, bounded repair turns, and failure contracts): structured-output.md
  • Sending screenshots and local images across protocols: images.md
  • Streaming live execution-phase progress in reasoning blocks: progress.md
  • Letting agents call functions in your own application (auto / managed / bridge / reject dual-layer tool bridging): Dual-Layer Harness
  • Live SDK compatibility lab & configuration guide for popular chat/IDE clients (Open WebUI, Dify, n8n, Continue, Cline, Zed): compatibility.md
  • Exposing agents over MCP: operations.md, "MCP and plugin entry" and MCP skill guide

Publishing & connecting agents

Notifications & webhooks

  • Pushing HMAC-SHA256 signed run events (completed, failed, awaiting approval) to your HTTPS endpoints with durable retries: webhooks.md

Deployment, security & team distribution

Architecture, evidence & contributing

Troubleshooting

On this page