OpenAgentCore README

The project's README from github.com/MiniMax-AI/OpenAgentCore. As one markdown file: README.md.

OpenAgentCore — One core. Many agents.

OpenAgentCore

An open-source, self-hosted implementation of the OpenAI Agents API with multiple native harnesses.

Website · Install · Call the API · Documentation · Contributing

English · 简体中文

What it is

OpenAgentCore runs AI agents on your own infrastructure behind the OpenAI Agents API.

How it fits together

OpenAgentCore architecture

Applications and operators use these Core APIs:

API Path Used by
Agents API /v1 Your applications. Same protocol as OpenAI's Agents API
Core API /core/v1 Operators, through Web

Core keeps durable execution state. The Runtime runs the chosen harness inside the Environment. Each connection is a defined protocol, so any part can be replaced on its own. See the architecture guide.

Screenshots

Overview Agent metrics
Deployment overview Agent metrics

Install

On Linux or macOS with Docker configured:

curl -fsSL https://github.com/MiniMax-AI/OpenAgentCore/releases/latest/download/install.sh | bash

Windows PowerShell:

irm https://github.com/MiniMax-AI/OpenAgentCore/releases/latest/download/install.ps1 | iex

Then:

  1. Sign in to Web, the admin console, with the Core key the installer created, and configure the domain and HTTPS.
  2. Set a default model and issue a Project API key.
  3. Add execution capacity: a node, E2B, or your own machine.
  4. Run your first Session with the OpenAI SDK.

The installation guide covers each step, HTTPS and a quick local trial. Listen addresses, ports and other options: installation options.

Documentation

I want to Start with
Install and operate an installation Installation, then operations
Build an application on the API Quickstart, then the Agents API guide
See a complete application Examples
Run agents on my own machine Self-hosted execution
Check Harness capabilities and limits Harness capabilities
Understand the design Architecture
Add a sandbox, harness or other component Developer guide

All pages: documentation index. Before changing code, read the contributor rules.

OpenAgentCore (MiniMax-AI/OpenAgentCore)

Searching Database…

这是什么?OpenAgentCore 是 OpenAI Agents API 的开源自托管实现,让你在自己的基础设施上运行 AI 代理,使用可插拔的原生 harness(如 Codex、Claude Code 或 MiniMax Code)。
这是我导入的库,还是我运行的服务器?它是一个由 Core 和 Runtime 组件组成的自托管后端服务;你的应用通过与 OpenAI 相同的 Agents API 协议或普通 HTTP 与它通信,而不是导入一个库。
怎么让它跑起来?在 Linux 或 macOS 上配置好 Docker 后运行安装程序,或使用 Windows 的 PowerShell 安装程序;然后用生成的 Core 密钥登录管理控制台 Web,配置域名/HTTPS,设置默认模型,并签发一个 Project API 密钥。
安装它需要 Docker 吗?在 Linux 或 macOS 上,运行安装程序之前需要先配置好 Docker;Windows 则改用一个单独的 PowerShell 安装程序。
我需要自己提供模型提供方和执行能力吗?需要——安装完之后,你仍然必须设置默认模型,并添加执行能力(比如节点、E2B 或你自己的机器),然后才能运行第一个会话。
它是面向谁的?面向想自己托管和运营 AI 编程代理、而不依赖 OpenAI 托管 Agents API 的团队,使用他们自己的模型提供方和基础设施。
代理实际在哪里执行?代理在受管沙盒(Docker、microsandbox 或 E2B)内运行,或者直接在你自己的 Linux、macOS 或 Windows 机器上运行,取决于你怎么配置执行能力。
它支持哪些编程代理?每个 Session 运行三个原生 harness 之一——Codex、Claude Code 或 MiniMax Code——并搭配你配置的任意模型提供方。
我能替换系统的部件吗?可以,沙盒、harness 和模型提供方都通过定义好的协议接入,因此任何组件都可以被独立替换。
长时间运行的会话是怎么追踪的?Core 持久保存执行状态,同时 Runtime 在 Environment 里运行所选的 harness,因此会话可以在重启和重连之后继续存在。
有管理界面吗?有,“Web”就是运维管理控制台,用于用 Core 密钥登录、配置域名/HTTPS,以及管理模型和 API 密钥。
Creator
MiniMax-AI
Size
33.6 MB
Stars
233
Age
26d
Commits · 90 Days