Parameters

ParameterTypeDefaultDescription
os_idOptional[str]Autogenerated UUIDAgentOS ID
descriptionOptional[str]NoneAgentOS description
agentsOptional[List[Agent]]NoneList of agents available in the AgentOS
teamsOptional[List[Team]]NoneList of teams available in the AgentOS
workflowsOptional[List[Workflow]]NoneList of workflows available in the AgentOS
interfacesOptional[List[BaseInterface]]NoneList of interfaces available in the AgentOS
configOptional[AgentOSConfig]NoneUser-provided configuration for the AgentOS
settingsOptional[AgnoAPISettings]NoneSettings for the AgentOS API
metricsOptional[MetricsConfig]NoneMetrics configuration
fastapi_appOptional[FastAPI]NoneFastAPI APP to use for the AgentOS
telemetryboolTrueLog minimal telemetry for analytics

Functions

get_app

Get the FastAPI APP 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
  • reload (bool): Enable auto-reload for development. Defaults to False