Skip to main content

Form Access

The Form Access ability gives your AI access to read, create, and update the records of a Data Type in your workspace. This lets the agent look up existing data and create new records through natural conversation.

Settings​

SettingDescription
Data TypeWhich Data Type to access
ReadAI can view records
CreateAI can create records
EditAI can modify records
Auto CreateAutomatically create a record for each assignment (useful for state tracking)
Read FieldsLimit which fields the AI can see when reading records (optional)
Write FieldsLimit which fields the AI can modify when updating records (optional)
Create FieldsLimit which fields the AI can set when creating records (optional)

How It Works​

When Form Access is enabled, the AI can interact with the specified Data Type's records based on the permissions you configure:

  • Read allows the AI to look up and display existing records. Useful for answering questions like "What's the status of order #1234?"
  • Create allows the AI to create new records by collecting field values through conversation
  • Edit allows the AI to modify existing records, such as updating a status field or correcting information

You can grant any combination of these permissions depending on your use case. The AI works only with records the member being served can reach — usually their own records and, for workspace-wide Data Types, the records every member can read — and the member needs no extra access for that. Saving the ability checks that you can use the Data Type; a Data Type marked Private to workspace admins can't be chosen.

Adding Form Access​

Form Access can be added at either the workflow or task level:

  1. Open your workflow or task
  2. Go to the Abilities tab
  3. Click Add Ability and select Form Access
  4. Select the Data Type to grant access to
  5. Configure the permission checkboxes (Read, Create, Edit)
  6. Optional: More options holds list size and order, the record set, Verify, List All and Geolocate.
  7. Save

Task-level abilities override workflow-level abilities of the same type.

Auto Create​

When Auto Create is enabled, the system automatically creates a record of this Data Type for each new assignment. This is useful when the Data Type serves as state storage for a workflow — the AI can immediately start updating fields without needing to create a record first. Auto Create does not run on test chats or prompt inspection — those previews still get the record tools, just without a seeded record.

For example, a "Game State" Data Type with autoCreate enabled gives each assignment its own state record from the start.

Field Filters​

Field filters let you control exactly which fields the AI can access. When no filters are set, the AI has access to all fields defined on the Data Type. When filters are set, only the specified fields are available.

FilterControlsExample Use
Read FieldsWhich fields appear when the AI reads recordsHide internal notes from the AI
Write FieldsWhich fields the AI can modify on existing recordsPrevent the AI from changing an ID field
Create FieldsWhich fields the AI can set on new recordsOnly allow the AI to set name and email

Each filter is independent — you can allow reading all fields but restrict writes to a subset, for example.

When to use field filters:

  • Privacy: Hide sensitive fields (SSN, internal notes) from the AI while still allowing access to other fields
  • Safety: Prevent the AI from overwriting system-managed fields
  • Focus: Reduce noise by only exposing relevant fields for the current task

Note: Field filters restrict the AI's tools only. Record metadata (ID, timestamps) is always visible. If a required field is excluded from create filters, the AI won't be able to create valid records — ensure required fields are included.

Tips​

  • Pair with Data Type design to ensure the AI has clear field names and descriptions to work with. See Data Types.
  • Use read-only access when the AI only needs to look up information, not modify it.
  • Add multiple Form Access abilities if the AI needs to work with more than one Data Type.
  • Use Auto Create with edge routing to give each assignment its own state record, then use tool-invocation edge conditions to route based on what the AI writes.

Conditional Activation​

You can restrict when Form Access is available using CEL expressions in the ability's Activation condition field. For example, you might only allow record creation for authenticated Members. The available variables depend on this context; see the Developer CEL reference. See Abilities for more on conditional abilities.

  • Abilities — Overview of all AI abilities
  • Data Types — Define the Data Types that Form Access works with
  • CEL Expressions — Write conditions for conditional activation