Agents Endpoint Object Structure

This page applies to the agents endpoint.

Example

Agents Endpoint

endpoints:
  agents:
    recursionLimit: 50
    maxRecursionLimit: 100
    disableBuilder: false
    # (optional) Agent Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
    # capabilities: ["execute_code", "file_search", "actions", "tools", "artifacts", "ocr", "chain"]

This configuration enables the builder interface for agents.

recursionLimit

Key	Type	Description	Example
recursionLimit	Number	Sets the default number of steps an agent can take in a run.	Controls recursion depth to prevent infinite loops. When limit is reached, raises GraphRecursionError. This value can be configured from the UI up to the maxRecursionLimit.

Default: 25

Example:

endpoints / agents / recursionLimit

recursionLimit: 50

For more information about agent steps, see Max Agent Steps.

maxRecursionLimit

Key	Type	Description	Example
maxRecursionLimit	Number	Sets the absolute maximum number of steps an agent can take in a run.	Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Default: If omitted, defaults to the value of recursionLimit or 25 if recursionLimit is also omitted.

Example:

endpoints / agents / maxRecursionLimit

maxRecursionLimit: 100

For more information about agent steps, see Max Agent Steps.

disableBuilder

Key	Type	Description	Example
disableBuilder	Boolean	Controls the visibility and use of the builder interface for agents.	When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Default: false

Example:

endpoints / agents / disableBuilder

disableBuilder: false

capabilities

Key	Type	Description	Example
capabilities	Array/List of Strings	Specifies the agent capabilities available to all users for the agents endpoint.	Defines the agent capabilities that are available to all users for the agents endpoint. You can omit the capabilities you wish to exclude from the list.

Default: ["execute_code", "file_search", "actions", "tools", "artifacts", "ocr", "chain"]

Example:

endpoints / agents / capabilities

capabilities:
  - "execute_code"
  - "file_search"
  - "actions"
  - "tools"
  - "artifacts"
  - "ocr"
  - "chain"

Note: This field is optional. If omitted, the default behavior is to include all the capabilities listed in the default.

Agent Capabilities

The capabilities field allows you to enable or disable specific functionalities for agents. The available capabilities are:

execute_code: Allows the agent to execute code.
file_search: Enables the agent to search and interact with files.
actions: Permits the agent to perform predefined actions.
tools: Grants the agent access to various tools.
ocr: Enables uploading files as additional context, leveraging Optical Character Recognition for extracting text from images and documents.

By specifying the capabilities, you can control the features available to users when interacting with agents.

Example Configuration

Here is an example of configuring the agents endpoint with custom capabilities:

Agents Endpoint

endpoints:
  agents:
    disableBuilder: false
    capabilities:
      - "execute_code"
      - "actions"
      - "artifacts"
      - "ocr"

In this example, the builder interface for agents is disabled, and only the execute_code, actions, and ocr capabilities are enabled.

Notes

It’s not recommended to disable the builder interface unless you are using modelSpecs to define a list of agents to choose from.

Balance MCP Servers