Arguments
Define the agent's inputs and outputs to control what information it receives and what it returns.
Arguments
The Arguments page defines what the agent needs to receive in order to work (input arguments) and what it returns once it has processed a request (output arguments).
Reach it through the Arguments icon in the editor's side navigation.
Input arguments
Input arguments are what the agent needs in order to work. A weather agent, for instance, might have a Location input argument.
You set each argument's type, whether it is required, and whether it should appear in the user interface.
The form, generated automatically
When one or more input arguments have Show in the UI enabled, the agent generates a form for the user to fill in before the conversation starts. With no argument set to show in the UI, the user works with the agent through chat or a prompt only.
Click Preview the form (available once at least one argument has Show in the UI on) to see how it will look.
Output arguments
Output arguments are what the agent returns once it has processed a request. An agent that reviews CVs, for instance, might return Score and Recommendation.
Output arguments are used by workflow and webhook runs, and come back as JSON.
The Show in the UI column only exists on the Input arguments tab. Output arguments never appear in a form.
The table's columns
| Column | What it is |
|---|---|
| Name | The argument's identifier. Used as a variable in the prompt with the {ArgumentName} syntax. Edit it by clicking the field. |
| Description | Explains the argument's purpose to the AI model. The more precise it is, the better the agent understands how to use it. Edit it in the field below the name. |
| Type | The format of the expected value. See the types below. |
| Required | With this on, the argument is mandatory — the run does not start without it. |
| Show in the UI | (Input only) With this on, the argument appears in the form generated for the user. |
Argument types
| Type | Icon | What it is for |
|---|---|---|
| Text | Aa | Any textual value |
| Number | 123 | Whole or decimal numbers |
| Date | A calendar | Dates in ISO format |
| Boolean | A switch | True or false |
| File | A clip | A file the user uploads |
| JSON | {} | A structured JSON object |
Adding an argument
- Select the Input arguments or Output arguments tab.
- Click + Add argument.
- A new argument appears with a default name (
Argument1,Argument2…), type Text and not required. - Click the Name field to rename it.
- Click the description field to spell out what the argument is for.
- Set the Type, Required and — for an input — Show in the UI.
Changes save themselves.
Removing arguments
Select one or more with the checkbox on the left of each row and click Remove selected. You are asked to confirm first.