OpenAgentCore runs AI agents on your own infrastructure behind the OpenAI Agents API. The architecture overview explains its parts. Pick the guides for your role.
Operators install Core and Web, add sandbox capacity and issue Project API keys.
| Guide | Covers |
|---|---|
| Install Core and Web | The default installation, from an empty host to the first Project API key |
| Installation options | Installer flags, existing reverse proxies, split and native deployments, offline hosts |
| Nodes | Adding, changing, removing and troubleshooting sandbox nodes |
| Operations | The oac command, the Core key, backups, uninstall, upgrades and troubleshooting |
| Configuration reference | Every setting, file and environment variable |
| Web console | What the console shows and manages |
Application developers call the API with a Project API key, and can run Sessions on machines they own.
| Guide | Covers |
|---|---|
| Quickstart | From a Project API key to a finished Session |
| Agents API guide | Common tasks, harness and model choice, and every resource with SDK and HTTP examples |
| Self-hosted execution | Running a Session on your own machine |
| Examples | Complete applications built on the API |
| API index | All three namespaces and their credentials |
Contributors start with the developer guide and CONTRIBUTING.md.