Skip to main content
Adds a route: when it applies, what the agent does step by step and its cases. The functions its actions name are mounted on the agent.

Endpoint

Required scope

agents:write

Path parameters

Body

An action is { kind, target }. kind is native (a platform function by name), tool (a webhook tool id), catalog, move_stage (a pipeline stage id), tag (a tag id) or send_file. Up to 60 per step or case.

Example request

curl

Response

201 Created

400 Bad Request

Missing title, an unknown action kind, steps nested more than 6 levels, or an unknown property at any level; or a scenarioId that is not an ObjectId.

404 Not Found

AGENT_NOT_FOUND when the agent belongs to another project of the company, UPSTREAM_ERROR (message AGENT_NOT_FOUND) when no agent has that id in the company; scenario_not_found when the agent has no scenario with that id.

422 Unprocessable Entity

too_many_routes (50 per scenario).

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the agents:write scope.

502 Bad Gateway

The agent service is unreachable.

Operational notes

  • Version 1 is written on create. Every later change of content adds one.
  • One route, one situation. Use not_applies_when to keep it from catching the case next door.