Skip to content

Deploying custom agents

Learn how to put custom agents to use in Canvas steps or catalog fields after you create them. For an introduction, see Braze Agents.

Agents in Canvas

You can use agents as steps in a journey to personalize messages or guide decisioning in real time. For detailed setup steps, refer to Agent Step.

Use cases

Agents in catalogs

You can apply an agent to catalog fields so it automatically generates or calculates values for each row. The agent will also run on new rows that are added to the catalog in the future.

Use cases

Steps

An Agent step in a catalog field.

To add an agent to your catalog field:

  1. In your catalog, add a new field.
  2. Select Apply AI agent.
  3. Assign an agent to this field.
  4. Select which columns should be passed as input. If none are selected, the agent will have access to all columns in the catalog.
  5. Decide if the agent should recalculate fields when catalog rows are updated. If you do not select this option, the agent will only run once per row.
  6. Select Add fields to deploy the agent and review cost estimations. The Cost estimation modal shows how many times the agent will run on this catalog, roughly equal to the total number of rows. To continue, select Confirm.

How catalog agents run

After launching, the agent will run and evaluate each row, taking the selected columns into its context to produce an output. Agents run on all new rows added after the agent is deployed. If you selected Recalculate when catalog rows update, all values for this field will update if existing source fields change.

Error handling in catalogs

  • Failed catalog invocations do not retry.
  • If the API call to the foundational model provider returns any error, such as an invalid API key error or a rate limit error, the field value will not be updated.
  • You can review the agent’s logs for details on failed runs.
HOW HELPFUL WAS THIS PAGE?
New Stuff!