开源、可自部署的 OpenAI Agents API。用官方 OpenAI SDK,在你自己的机器上用你自己的模型运行 Codex、Claude Code 或 MiniMax Code。
English · 简体中文
- 与 OpenAI 相同的 API。 设置
OPENAI_BASE_URL后,官方 OpenAI SDK或直接的 HTTP 调用无需改动即可使用。 - 你的 Agent,你的模型。 每个 Session 原生运行 Codex、Claude Code 或 MiniMax Code,使用你配置的模型提供商,与在本机运行一致。详见 Harness 能力。
- 计算会休眠,工作区会保留。 在 microsandbox 上(每个工作区都保存在独立存储中),空闲沙箱释放计算资源,并在兼容节点上带着文件恢复。E2B 会就地暂停空闲沙箱。Docker 以及你自己的 Linux、macOS 或 Windows 机器同样可以运行 Session。详见沙箱提供商协议。
- 部件可替换。 沙箱提供商、工作区文件系统、Harness 和模型提供商都通过既定协议接入。
在 Linux 或 macOS 上,按前置条件准备好 Docker 后,安装 Core、Web 和 PostgreSQL:
curl -fsSL https://openagentcore.dev/install.sh | bash在 Windows 上,使用 PowerShell:
irm https://github.com/MiniMax-AI/OpenAgentCore/releases/latest/download/install.ps1 | iex在 Web 中,用安装程序输出的 Core 密钥登录,配置公共地址,设置默认模型,签发项目 API 密钥,并添加沙箱容量(节点或 E2B)。每一步见安装 Core 和 Web。
然后用 OpenAI SDK 调用,将 OPENAI_BASE_URL 设为你的 API 基础地址(https://core.example/v1),OPENAI_API_KEY 设为项目 API 密钥:
from openai import OpenAI
client = OpenAI() # reads OPENAI_BASE_URL and OPENAI_API_KEY
session = client.beta.agents.sessions.create(
environment={"type": "openai_hosted"},
input="Create /workspace/hello.txt with a short greeting, then describe it.",
extra_body={"agent": {"x_agents_core": {"harness": "codex"}}},
)
print(session.id)运行第一个 Session会等待结果并读回。
应用和管理员使用以下 Core API:
| API | 路径 | 调用方 |
|---|---|---|
| Agents API | /v1 |
你的应用,与 OpenAI 的 Agents API 协议一致 |
| Core API | /core/v1 |
管理员,通过 Web 调用 |
持久化执行状态由 Core 保存;Runtime 在 Environment 中运行所选 Harness。各部件之间都通过既定协议连接,任何一个都可以单独替换。详见架构。
| 我想要 | 从这里开始 |
|---|---|
| 安装并运维 | 安装 Core 和 Web,然后看运维 |
| 基于 API 开发应用 | 运行第一个 Session,然后看 Agents API 指南 |
| 看一个完整的应用 | 示例 |
| 在自己的机器上运行 Agent | 自托管执行器 |
| 查看 Harness 能力和限制 | Harness 能力 |
| 了解设计 | 架构 |
| 接入新的沙箱、Harness 或其他组件 | 开发 OpenAgentCore |
修改代码前请阅读 CONTRIBUTING.md。缺陷和问题请提交到 GitHub Issues。基于 MIT 许可证发布。
