Skip to main content
PATCH
Update an auto-fill agent

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.

Path Parameters

id
string
required

The auto-fill agent id (pagent_…).

Body

application/json

A partial patch. Only the provided fields change; sources is merged onto the current toggles.

kind
enum<string>
Available options:
summarize,
research,
classify,
prompt
instructions
string
model
string
sources
object

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

triggerTypes
enum<string>[]
Available options:
onCreate,
onUpdate,
recurring
onlyIfEmpty
boolean
isEnabled
boolean

Response

The updated 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"