Open Agent API

文档导航

欢迎查阅 Open Agent API 文档。如果你是第一次接触本项目,建议直接从 五分钟上手:从发布智能体到第一次调用 与 可运行示例集(Cookbook) 开始。


我想快速上手

  • 五分钟走完「发布智能体 → 生成密钥 → SDK 实机调用」全流程:quickstart.md(或参阅仓库首页 三分钟跑起来)
  • 各平台安装与卸载指南(macOS / Windows / Linux 桌面端、一键脚本、Docker、npm 包):install.md
  • 控制台各功能视图说明(概览、对话工作台 #workbench、任务时间线、事件回调与开发者平台):console.md
  • 命令行速查表(按启动网关、接入智能体、终端审批、密钥管理、真机验收分组):cli.md
  • Windows 环境运行与路径说明:windows.md
  • 本机启动配置与后台常驻细节:operations.md「本机启动」

我想调用智能体与编排任务

  • 直接复制运行的调用代码(涵盖 cURL 及 OpenAI / Claude / Gemini 的 Python 与 Node 示例):示例集 Cookbook
  • 自动选路(@fast / @best / @eco)、仅输出方案(recommend)、多智能体协作与模型实测评估:智能选路与编排
  • 跨会话共享项目记忆(SQLite FTS5)、持久长任务、可视化 DAG 工作流(Cron / Webhook 触发)与大体积媒体产物:工作台与工作流
  • 一键把已发布智能体注入本机 IDE 与客户端(支持 OpenCode / Codex / DSH API 通道与 Cursor / Windsurf / Claude Desktop / Claude Code MCP 通道):本地互联
  • 查看 Token 消耗统计、单把密钥预算上限与上游额度快照:用量与额度
  • 使用 OpenAI SDK 或原生 oaa/1 接口发起调用与交接(Handoff):operations.md「发布与调用」
  • 四大协议字段对照、文件上传、流式事件、审批恢复与取消语义:protocol.md「Compatibility」、「Execution and actions」
  • 保证符合 JSON Schema 的结构化输出(原生下推、自动修正轮与失败契约):structured-output.md
  • 发送截图与本地图片(各协议格式、大小上限与隐私策略):images.md
  • 在流式响应中实时透传智能体执行阶段进度:progress.md
  • 让智能体回调调用方自己定义的本地函数(auto / managed / bridge / reject 双层工具桥接):双层 Harness 指南
  • 官方 SDK 实连测试范围与主流第三方客户端(Open WebUI、Dify、n8n、Continue、Cline、Zed 等)配置表:compatibility.md
  • 通过 MCP 协议暴露智能体给编辑器调用:operations.md「MCP 与插件入口」、MCP 技能说明

我想发布与接入智能体

我想接收通知或对接外部系统

  • 订阅任务完成、失败或待审批事件(HMAC-SHA256 签名 HTTPS Webhook 与持久化重试队列),或把审批接入自有IM/工单系统:webhooks.md

我想部署上线或向团队分发

我想了解架构、实测证据与参与贡献

我想排查报错

本页内容