Add a form agent

A form agent helps a user fill out a form through conversation. Instead of showing static fields, it asks questions one at a time and collects structured answers matching a schema you define — combining a chat experience with the structured output of an extraction agent.

Agents live in your workspace and are created from the New Agent card on the workspace overview (or the + next to Agents in the left sidebar). Choosing the Form type is what turns the agent into a guided form.

How a form agent works

You define a Form Configuration (a JSON schema listing the fields to collect, for example fullName and email), a Greeting the agent opens with, and Instructions describing how it should guide the user. A form agent has three configuration tabs — General, Model and Form — and each tab is its own form that saves on its own (the editor warns you before you leave a tab with unsaved changes).

The full flow at a glance

The walkthrough below replays every step in the real interface. Use Prev / Next to move at your own pace; each step highlights the button to click and the area to watch.

Step by step

1. Open the New Agent dialog

On the workspace overview, find the New Agent card and click Create (you can also use the + next to Agents in the left sidebar).

2. Choose the Form type

In the New Agent dialog, under Agent type, select Form. The type determines what the agent does, so pick it before continuing.

3. Name the agent and create it

Type a Name (at least 3 characters) in the Name field, then click Create. Your agent is created with sensible defaults and opens in the editor.

4. Set the basics on General

The editor opens on the General tab. Set the:

• Name — how the agent appears in your workspace.
• Locale — the language the agent works in.
• Greeting — the first message the agent sends when a conversation starts.
• Instructions — how the agent should guide the user through the form.

Click Save.

5. Pick the model on Model

Open the Model tab, choose the Model that powers the agent and a Temperature (lower values give steadier, more predictable questions). Save.

6. Define the fields on Form

Open the Form tab and edit the Form Configuration — the JSON schema that describes each field to collect. List your fields under properties, give each a type and a description, and mark the mandatory ones in required. Click Save. Because each tab saves on its own, remember to Save every tab you change.

Tips

• Keep field descriptions clear — the agent uses them to phrase each question and to decide what to store.
• The Greeting sets the tone; write it in the same language as the agent’s Locale.
• Use a low Temperature (for example 0.2) so the agent asks consistent questions rather than improvising.
• Each tab saves separately — changes on one tab aren’t kept when you move to another without saving.

Troubleshooting

• The Create button is disabled — the Name must be at least 3 characters.
• My Form Configuration won’t save — it must be a valid JSON object; check for a trailing comma or a missing quote.
• My changes disappeared — each tab saves separately; click Save before switching tabs (the editor warns you when changes are unsaved).
• I don’t see a Form tab — make sure you created a Form agent (conversation agents chat, extraction agents show an Output tab instead).