AgentOS

Parameters

Parameter	Type	Default	Description
id	Optional[str]	Autogenerated UUID	AgentOS ID
name	Optional[str]	None	AgentOS name
description	Optional[str]	None	AgentOS description
version	Optional[str]	None	AgentOS version
agents	Optional[List[Agent]]	None	List of agents available in the AgentOS
teams	Optional[List[Team]]	None	List of teams available in the AgentOS
workflows	Optional[List[Workflow]]	None	List of workflows available in the AgentOS
interfaces	Optional[List[BaseInterface]]	None	List of interfaces available in the AgentOS
config	Optional[Union[str, AgentOSConfig]]	None	User-provided configuration for the AgentOS. Either a path to a YAML file or an AgentOSConfig instance.
settings	Optional[AgnoAPISettings]	None	Settings for the AgentOS API
base_app	Optional[FastAPI]	None	Custom FastAPI APP to use for the AgentOS
lifespan	Optional[Any]	None	Lifespan context manager for the FastAPI app
enable_mcp_server	bool	False	Whether to enable MCP (Model Context Protocol)
on_route_conflict	Literal["preserve_agentos", "preserve_base_app", "error"]	"preserve_agentos"	What to do when a route conflict is detected in case a custom base_app is provided.
telemetry	bool	True	Log minimal telemetry for analytics

Functions

get_app

Get the FastAPI APP configured for the AgentOS.

get_routes

Get the routes configured for the AgentOS.

serve

Run the app, effectively starting the AgentOS.

Parameters:

• app (Union[str, FastAPI]): FastAPI APP instance
• host (str): Host to bind. Defaults to localhost
• port (int): Port to bind. Defaults to 7777
• workers (Optional[int]): Number of workers to use. Defaults to None
• reload (bool): Enable auto-reload for development. Defaults to False