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…

What is this?OpenAgentCore is an open-source, self-hosted implementation of the OpenAI Agents API that lets you run AI agents on your own infrastructure using pluggable native harnesses like Codex, Claude Code or MiniMax Code.
Is this a library I import, or a server I run?It is a self-hosted backend service made of a Core and Runtime component; your applications talk to it through the same Agents API protocol as OpenAI, or plain HTTP, rather than importing a library.
How do I get it running?On Linux or macOS run the installer with Docker configured, or use the Windows PowerShell installer; then sign in to Web, the admin console, with the generated Core key, configure the domain/HTTPS, set a default model and issue a Project API key.
Do I need Docker to install it?On Linux or macOS you need Docker already configured before running the installer; Windows uses a separate PowerShell installer instead.
Do I need to supply my own model provider and execution capacity?Yes — after installing you still have to set a default model and add execution capacity such as a node, E2B, or your own machine before you can run your first session.
Who is this aimed at?It's for teams who want to host and operate AI coding agents themselves rather than depend on OpenAI's hosted Agents API, using their own model providers and infrastructure.
Where do the agents actually execute?Agents run inside a managed sandbox (Docker, microsandbox or E2B), or directly on your own Linux, macOS or Windows machine, depending on how you configure execution capacity.
Which coding agents does it support?Each Session runs one of three native harnesses — Codex, Claude Code or MiniMax Code — paired with whichever model provider you configure.
Can I swap out parts of the system?Yes, sandboxes, harnesses and model providers all plug in through defined protocols, so any component can be replaced independently.
How are long-running sessions tracked?Core keeps durable execution state while the Runtime runs the chosen harness inside the Environment, so sessions can survive restarts and reconnects.
Is there an admin interface?Yes, 'Web' is the operator admin console used to sign in with the Core key, configure the domain/HTTPS, and manage models and API keys.
Creator
MiniMax-AI
Size
34.1 MB
Stars
234
Age
28d
Commits · 90 Days