The Property Agent object

A property agent is Custral’s AI auto-fill: a configuration attached to a single property (column) that fills the property’s value with AI. When it runs (manually, or on a record event) it reads its declared sources (the record’s own fields and, for research, the web) and writes a value into the property. One auto-fill is allowed per property. The endpoints in this section let you list, retrieve, set up, update, and delete them. To run a record’s configured auto-fills, enrich the record through the MCP enrich_record tool or the in-app Run AI auto-fill action.

{
  "id": "pagent_3Ab9xK2mQ7",
  "objectId": "obj_2Zk1",
  "propertyId": "prop_industry",
  "kind": "research",
  "instructions": "Using the record's Website, output the company's industry.",
  "model": "auto",
  "sources": { "recordContext": true, "workspacePages": false, "web": true },
  "triggerTypes": [],
  "recurringCron": null,
  "scopeFilterJson": null,
  "dependsOn": [],
  "requiresProperties": [],
  "onlyIfEmpty": false,
  "isEnabled": true,
  "createdAt": "2026-08-10T12:00:00.000Z",
  "updatedAt": "2026-08-10T12:00:00.000Z"
}

Attributes

string

Unique identifier, prefixed pagent_.

string | null

The object (obj_) the target property belongs to.

string | null

The property (prop_) this auto-fill writes to. Unique, one auto-fill per property.

string | null

The behavior preset: summarize (derive from the record’s own fields), research (use the web), classify (pick select option(s)), or prompt (run an arbitrary instruction).

string | null

The natural-language instruction telling the AI what to output for the property.

string | null

The model the agent runs with. auto uses the workspace default.

object

Which context the agent reads from: recordContext (the record’s own fields) and web (web research). workspacePages is not settable over the API and is always false.

array

The automatic triggers: any of onCreate, onUpdate, recurring. An empty array means the auto-fill runs only when invoked manually.

string | null

The cron expression for the recurring trigger, or null.

array

propertyIds of other auto-fills on the same object that must run before this one during object-level enrichment.

array

propertyIds that must hold a non-empty value on the record before this agent runs; otherwise the run is skipped.

boolean

When true, the agent only writes if the property is currently empty, protecting human-entered values.

boolean

Whether the auto-fill is active. Set false to pause it without deleting it.

string | null

ISO 8601 creation timestamp.

string | null

ISO 8601 last-update timestamp.

Introduction

Endpoints

Embeds & real-time

The Property Agent object

Attributes

​Attributes

Attributes