Agents
An agent is a reusable base configuration that users build projects from. Every project in BasePeak.AI is created from an agent, which determines which capabilities, tools, and model the project starts with.
Admins manage agents at /admin/agents.
The default agent
One agent can be marked as the default agent. Non-admin users can only create new projects from the default agent. Admins can create projects from any agent.
To change the default agent, click Set default agent on the Agents page and select from the list.
Creating and deleting agents
- Create — Click the + button to create a new agent. You are taken directly to the agent editor to configure it.
- Delete — Use the row action menu on the Agents list. Deleting an agent does not delete projects already created from it.
Agent editor
Clicking an agent's row opens the editor, which is organised into the following sections.
Name and description
Set a human-readable name and optional description. These are visible to users when choosing which agent to base a project on.
Capabilities
Capabilities control which built-in features are available to projects created from this agent. Each capability can be set to one of four modes:
| Mode | Description |
|---|---|
| Always On | The capability is always active; users cannot disable it |
| Optional - On | The capability is active by default; users can turn it off |
| Optional - Off | The capability is available but off by default; users can turn it on |
| Off | The capability is disabled and not available to users |
The configurable capabilities are:
| Capability | Description |
|---|---|
| Knowledge | Allows the project creator to upload files that serve as a searchable knowledge set for the agent |
| Workspace Files | Allows the project creator and users to upload files to a shared workspace the agent can read and write |
| Tasks | Enables users to create tasks in the project |
| Threads | When disabled, users are limited to a single non-deletable thread in the project |
| Memory | Enables the agent to retain information across threads |
Tools
This section configures which tools are available to projects created from this agent. Any tool not included here will not be available in those projects, so when configuring the default agent, include the full set of tools you want users to have access to.
Each tool can be set to one of the same four modes as capabilities (Always On, Optional - On, Optional - Off, Off).
Tools that require OAuth can be pre-authenticated at the agent level. This is generally only recommended for single-user agents, since the credentials are shared with all users.
Actions
Actions are custom shortcuts that appear in the project interface. Each action has a name, a description shown to the user, a prompt that guides the agent, and an optional subset of the agent's tools to use. Actions let you surface common workflows as one-click prompts.
Knowledge
Attach knowledge sets directly to the agent. Knowledge attached here is available to all projects created from this agent.
Workspace Files
View and manage files in the agent's workspace.
Access control
Review which users and groups have access to projects based on this agent.
Advanced
Model
Select which language model the agent uses. Choosing Use system default means the agent inherits the platform default model configured on the Model Providers page.
Allowed model providers
Restrict which configured model providers users may select when choosing a model for their project. If left empty, all configured providers are available.
Environment variables
Set key-value environment variables that are passed to all tools invoked by this agent and by projects created from it. Use this to supply API keys or configuration values that tools need at runtime.