Skip to main content
POST
Set up auto-fill on a property

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Body

application/json

Set up AI auto-fill on a property. One auto-fill is allowed per property.

objectId
string
required

The object (obj_…) the property belongs to.

Example:

"obj_123"

propertyId
string
required

The property (prop_…) to auto-fill.

Example:

"prop_123"

kind
enum<string>
required
Available options:
summarize,
research,
classify,
prompt
Example:

"research"

instructions
string
required

What the AI should output for the property.

model
string

Model id, or auto (default).

sources
object

Context toggles. Omitted toggles default sensibly for the kind (research enables the web).

triggerTypes
enum<string>[]

Automatic triggers; omit for manual-only.

Available options:
onCreate,
onUpdate,
recurring
onlyIfEmpty
boolean

Only write when the property is empty. Defaults to false.

isEnabled
boolean

Whether the auto-fill is enabled. Defaults to true.

Response

The created auto-fill agent.

data
object

An AI auto-fill agent — the config attached to a single property that fills its value with AI.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"