Skip to main content

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.

What a new agent starts with​

Create Agent does not produce a blank agent. It starts on the same baseline as the built-in assistant: Workspace Files and Tasks always on, Date and Time and Search Knowledge on by default. Each is an ordinary row you can re-mode or remove.

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.

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.

A tool added from the catalog arrives On by default: on in new chats, and still the user's to switch off.

Each tool uses the same modes as capabilities, minus Off: for a tool, "not available" simply means it is not assigned, so remove it with the trash icon instead.

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.

Capabilities​

Capabilities control which built-in features are available to projects created from this agent. Each mode answers two questions: is the capability on when a chat or project starts, and may the user change it?

ModeOn at startUser can change itMeaning
Always onyesnoActive in every chat. Users cannot switch it off.
On by defaultyesyesActive when a chat or project starts. Users can switch it off.
Off by defaultnoyesOffered but off. Users can switch it on themselves.
OffnonoNot available. Users never see it.

The same four modes name availability throughout the editor — for tools and capabilities, and for the data-protection and model-routing options under Advanced.

The configurable capabilities are:

CapabilityDescription
Search KnowledgeAllows the project creator to upload files that serve as a searchable knowledge set for the agent
Workspace FilesAllows the project creator and users to upload files to a shared workspace the agent can read and write
TasksEnables users to create tasks in the project
ThreadsWhen disabled, users are limited to a single non-deletable thread in the project
MemoryEnables the agent to retain information across threads

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.

This section needs the Search Knowledge capability. With it off the agent has no tool to search with, so anything added here would be stored and then never read — the section says so, and offers to switch the capability on. Knowledge that already exists stays visible either way, so it can still be detached.

Workspace Files​

View and manage files in the agent's workspace.

Access control​

Who may reach this agent. This is not a review surface — it is where access is granted, and it is edited in the Publish dialog alongside the agent's address, because those are one decision.

A new agent has no entries, and that means nobody: a user's agent list is built from these grants alone, so an agent with none appears in no user's list. The card says so until you add someone. Instance admins always reach any agent, as does anyone who already holds a project on it, so neither is listed here.

Grants and revocations apply immediately — Cancel in the Publish dialog discards only the address.

Advanced​

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.