Skip to content

OpenAgentCore documentation

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 ​

Operators install Core and Web, add sandbox capacity and issue Project API keys.

GuideCovers
Install Core and WebThe default installation, from an empty host to the first Project API key
Installation optionsInstaller flags, existing reverse proxies, split and native deployments, offline hosts
NodesAdding, changing, removing and troubleshooting sandbox nodes
OperationsThe oac command, the Core key, backups, uninstall, upgrades and troubleshooting
Configuration referenceEvery setting, file and environment variable
Web consoleWhat the console shows and manages

Application developers ​

Application developers call the API with a Project API key, and can run Sessions on machines they own.

GuideCovers
QuickstartFrom a Project API key to a finished Session
Agents API guideCommon tasks, harness and model choice, and every resource with SDK and HTTP examples
Self-hosted executionRunning a Session on your own machine
ExamplesComplete applications built on the API
API indexAll three namespaces and their credentials

Contributors start with the developer guide and CONTRIBUTING.md.

Released under the MIT License.