Skip to main content
AgentOS transforms your agents into a production-ready API. A minimal application looks like this:
my_os.py

Parameters

See AgentOS class reference for details.

Methods

get_app()

Returns the configured FastAPI application.

serve()

Starts the AgentOS server.

Environment variable fallbacks

When host or port are not passed explicitly, serve() reads from environment variables before using defaults. Precedence: explicit argument > environment variable > default value. This is useful for containerized deployments where host and port are configured externally:
my_os.py

resync()

Reloads agents, teams, workflows, and resources.

Configuration

The config parameter accepts a YAML path or AgentOSConfig object. Use it to configure prompts, display names, and database settings.
See Configuration for details.