help / router / agents_update

agents_updatewrite

PATCH /api/agents/:id — update mutable fields (owner of this agent, or master) · auth: authenticated

PATCH /api/agents/:id

signature sha256:eb6a626f6c744c824cfa5ca1466a1809

Parameters

nametyperequirednotes
idstringyesAgent definition id (uuid).
namestringnoHuman-readable label.
descriptionstring | nullnoWhat the agent does, in prose.
scriptstringnoJavaScript source to execute (ES2023).
cron_expressionstringnoFive-field cron expression.
timezonestring | nullnoIANA timezone for cron evaluation.
timeout_msnumber | nullnoPer-run wall-clock timeout (ms).
hold_cost_nanonumber | nullnoToken hold placed before each run (nano; 1 USD = 1e9).
envobject | nullnoKey/value pairs injected into the sandbox.
enabledboolean | nullnoWhether the scheduler ticks this definition.

Response

nametypedescription
definitionobject

Call it

write requires auth: authenticated