Schema Builder

The Schema Builder lets you define configuration schemas that users must complete when deploying your template. This creates a structured onboarding experience.

What Schemas Do

Configuration schemas serve three purposes:

• Define required setup fields -- what information is needed before the agent can run
• Validate user input -- ensure data is correct before deployment
• Customize agent behavior -- inject user-provided values into prompts and settings at deployment time

Field Types

Type	Description	Example
text	Single-line text input	Company name
textarea	Multi-line text input	Agent instructions
select	Dropdown select	Industry selection
number	Numeric input	Max tickets per day
boolean	Checkbox	Enable notifications
email	Email address input	Support email
url	URL input	Webhook endpoint

Using Schema Values in Prompts

Schema values are referenced in prompts using double-brace syntax: {{company_name}}, {{support_email}}, {{support_hours}}. When a user deploys the template and fills in these fields, the values are injected into the agent's prompts automatically.

Building a Schema

Via the Dashboard

1. Open Studio > Schema tab
2. Click Add Field for each configuration option you need
3. Configure field properties (name, type, label, description)
4. Mark fields as required or optional
5. Add validation rules (email format, URL format, regex patterns)
6. Set default values where appropriate
7. Click Preview to see the onboarding form as users will see it

Validation Options

Validation	Description
Required	Field must be filled in before deployment
Format: email	Must be a valid email address
Format: uri	Must be a valid URL
Pattern	Custom regex pattern (e.g., phone number format)
Enum values	Restrict to a predefined list of options

Best Practices

1. Keep it minimal -- only ask for essential configuration; users abandon long forms
2. Provide defaults -- make setup easier with sensible default values
3. Write clear descriptions -- help users understand what each field is for
4. Validate early -- catch errors before deployment, not after

---

Next: Learn about Orchestration rules.