AgentOS Parameters

Learn about the attributes of the AgentOS class

You can configure the behaviour of your AgentOS by passing the following parameters to the AgentOS class:

• agents: List of agents to include in the AgentOS
• teams: List of teams to include in the AgentOS
• workflows: List of workflows to include in the AgentOS
• interfaces: List of interfaces to include in the AgentOS.
  • See the Interfaces section for more details.
• config: Configuration file path or AgentOSConfig instance.
  • See the Configuration page for more details.
• base_app: Optional custom FastAPI app to use instead of creating a new one.
  • See the Custom FastAPI App page for more details.
• lifespan: Optional lifespan context manager for the FastAPI app.
  • See the Lifespan page for more details.
• enable_mcp_server: Turn your AgentOS into an MCP server.
  • See the MCP enabled AgentOS page for more details.
• on_route_conflict: Optionally preserve your custom routes over AgentOS routes (set to "preserve_base_app"). Defaults to "preserve_agentos", preserving the AgentOS routes.
  • See the Overriding Routes page for more details.

See the AgentOS class reference for more details.