AgentOS is a FastAPI app that you can run locally or in your cloud. If you want to build AgentOS using an existing FastAPI app, check out the Custom FastAPI App guide.
Prerequisites
- Python 3.9+
- An LLM provider API key (e.g.,
OPENAI_API_KEY
)
Installation
Create and activate a virtual environment:Minimal Setup
Createmy_os.py
:
Running Your OS
Start your AgentOS:- App Interface:
http://localhost:7777
- Use this URL when connecting to the AgentOS control plane - API Documentation:
http://localhost:7777/docs
- Interactive API documentation and testing - Configuration:
http://localhost:7777/config
- View AgentOS configuration - API Reference: View the AgentOS API documentation for programmatic access
Connecting to the Control Plane
With your AgentOS now running locally (http://localhost:7777
), you can connect it to the AgentOS control plane for a enhanced management experience. The control plane provides a centralized interface to interact with your agents, manage knowledge bases, track sessions, and monitor performance.