Form Fields

Configure form input fields for your agents to collect structured information from users before starting a conversation.

Overview

When you set your agent's input type to Form, you can define custom input fields that users must fill out before chatting. This structured approach ensures the agent receives consistent, well-organized information for every conversation.

Forms are ideal for:

• Standardizing how users provide context to the agent
• Ensuring all required information is captured upfront
• Reducing back-and-forth clarification questions
• Creating a survey-like experience for specific use cases

Field Types

Each field type serves a different purpose. Choose the right type based on what information you need to collect.

Text

Single-line text input for short responses.

Example use cases:

• Customer name
• Project title
• Product SKU
• Company name

Multi-line Text

Multi-line text area for longer content.

Example use cases:

• Detailed problem descriptions
• Feedback or suggestions
• Meeting notes for summarization
• Content to be analyzed or rewritten

Number

Numeric input field.

Example use cases:

• Budget amount
• Number of participants
• Priority score (1-10)
• Quantity to order

Checkbox

Boolean toggle for yes/no choices.

Example use cases:

• "I agree to the terms"
• "Include detailed analysis"
• "Rush processing needed"
• "Send email notification"

File

File upload field for documents, images, data files, and videos.

Example use cases:

• Resume for analysis
• Document to summarize
• Image for description
• Data file for processing

Select

Dropdown menu with predefined options.

Example use cases:

• Department selection
• Priority level (Low, Medium, High)
• Language preference
• Product category

Multi-select

Selection field where users can choose multiple predefined options.

Example use cases:

• Relevant departments
• Preferred contact channels
• Applicable product categories
• Required report sections

Date

Date picker for selecting specific dates.

Example use cases:

• Project deadline
• Event date
• Report period
• Meeting date

Email

Email address input with built-in format validation.

Example use cases:

• Customer contact email
• Notification recipient
• Account email for lookup
• Report delivery address

Field Properties

Every field shares common properties that control its behavior and appearance.

Common Properties

Each Name must be unique in the form. New fields start with Required on. Required is unavailable for Checkbox fields, which save as optional.

Limits

Type-Specific Properties

File:

Select and Multi-select:

Email:

Creating a Form Input Agent

Follow these steps to create an agent with form inputs. Alternatively, describe the form in the Agent Builder chat and it generates the fields for you.

Step 1: Create a New Agent

1. Navigate to Agents in the sidebar
2. Click Create agent. The Agent Builder chat opens
3. Click Go to editor to open the configuration editor
4. Give your agent a name and description

Step 2: Set Input type to Form

1. In the agent configuration, find Input type
2. Select Form instead of the default Prompt option

Step 3: Add Form Fields

1. Click Add input field to create a new input field
2. Select the field type from the dropdown
3. Configure the field properties:
   • Enter a clear, descriptive Name
   • Add Description (optional) text if needed
   • Leave Required on, or turn it off. Required is unavailable for Checkbox
   • Set type-specific options (options for Select and Multi-select fields)
4. Repeat for each field you need

Step 4: Order Your Fields

Drag and drop fields to arrange them in a logical order. Place the most important or contextually first fields at the top.

Step 5: Write Instructions

In the agent's Instructions, reference the form fields to tell the agent how to use the collected information:

You are a customer support specialist. Use the following information provided by the user:

- Customer Name: Use this to personalize your responses
- Issue Category: Focus your troubleshooting on this specific area
- Problem Description: Analyze this to understand the core issue
- Priority Level: Adjust your response urgency accordingly

Always address the customer by name and provide solutions relevant to their selected category.

Step 6: Test Your Form

1. Switch the Build and Test toggle to Test to preview the form
2. Fill out the form as a user would
3. Verify the agent receives and uses the information correctly
4. Adjust field names or instructions if needed
5. Click Create in the top bar to publish the first version

Example Configurations

Customer Support Intake

Fields:
1. Customer name (Text, required)
   - Name: "Your Name"

2. Email (Email, required)
   - Name: "Email Address"

3. Category (Select, required)
   - Name: "Issue Category"
   - Options: Billing, Technical, Account, Other

4. Description (Multi-line Text, required)
   - Name: "Describe Your Issue"
   - Description: "Please provide as much detail as possible"

5. Urgency (Select)
   - Name: "How urgent is this?"
   - Options: Low, Medium, High, Critical

Document Analysis

Fields:
1. Document (File, required)
   - Name: "Upload Document"
   - File Types: .pdf, .docx, .txt

2. Analysis Type (Select, required)
   - Name: "What type of analysis?"
   - Options: Summary, Key Points, Sentiment, Translation

3. Additional Context (Multi-line Text)
   - Name: "Any specific focus areas?"
   - Description: "Optional: Tell us what aspects to focus on"

Project Brief Generator

Fields:
1. Project Name (Text, required)
   - Name: "Project Name"

2. Objectives (Multi-line Text, required)
   - Name: "Project Objectives"
   - Description: "What are you trying to achieve?"

3. Budget (Number)
   - Name: "Budget (USD)"

4. Deadline (Date, required)
   - Name: "Target Completion Date"

5. Include Timeline (Checkbox)
   - Name: "Generate detailed timeline"

Best Practices

Only ask for information the agent actually needs. Every additional field increases friction and the chance users abandon the form.

Labels should clearly indicate what information is expected. Avoid jargon or internal terminology that users might not understand.

Use the description field to provide examples or clarify expectations. This reduces errors and improves the quality of inputs.

Mark fields as required only when absolutely necessary. Too many required fields frustrate users; too few may result in incomplete information.

Arrange fields in a natural flow. Start with identifying information, then move to specifics, and end with optional fields.

Explicitly tell the agent how to use each form field in your instructions. This ensures the collected information is actually utilized effectively.

Comparison: Form vs Prompt Input

Next Steps

• Agent Configuration — Learn about all agent configuration options
• Agent Templates — Browse pre-built agent configurations
• Agent Creation Guide — Detailed guide for building effective agents
• Prompting Guide — Write better agent instructions

FAQ

Use form fields when an agent needs structured input before the conversation starts. They are useful for intake workflows, standardized requests, and cases where required details should not be hidden in a free-text prompt.

Check field names, required fields, input types, and whether the agent instructions explicitly reference the form values. Test with representative submissions and adjust instructions if the agent ignores or misinterprets a field.