Configuring your AgentOS
What can be configured?- Display names: You can specify the display name for your AgentOS pages (Sessions, Memory, etc). This is very useful when using multiple databases, to clearly communicate to users which data is being displayed.
- Quick prompts: You can provide one to three quick prompts for each one of your agents, teams and workflows. These are the prompts that display on the Chat Page when you create a new session.
Setting your configuration
You can provide your AgentOS configuration in two different ways: with a configuration YAML file, or using theAgentOSConfig
class.
See the full reference for the
AgentOSConfig
class here.Configuration YAML File
- Create a YAML file with your configuration. For example:
- Pass the configuration to your AgentOS using the
config
parameter:
AgentOSConfig
Class
You can also provide your configuration using the AgentOSConfig
class:
The /config endpoint
You can use the/config
endpoint to inspect your AgentOS configuration that is served to the AgentOS Control Plane.
This is the information you will find there:
- OS ID: The ID of your AgentOS (automatically generated if not set)
- Description: The description of your AgentOS
- Databases: The list of IDs of the databases present in your AgentOS
- Agents: The list of Agents available in your AgentOS
- Teams: The list of Teams available in your AgentOS
- Workflows: The list of Workflows available in your AgentOS
- Interfaces: The list of Interfaces available in your AgentOS. E.g. WhatsApp, Slack, etc.
- Chat: The configuration for the Chat page, which includes the list of quick prompts for each Agent, Team and Workflow in your AgentOS
- Session: The configuration for the Session page of your AgentOS
- Metrics: The configuration for the Metrics page of your AgentOS
- Memory: The configuration for the Memory page of your AgentOS
- Knowledge: The configuration for the Knowledge page of your AgentOS
- Evals: The configuration for the Evals page of your AgentOS
See the full schema for the
/config
endpoint here.