Skip to main content
automation · 9 tools · Mounted by default Automations run work without you present — on a cadence, at an instant, or on demand. Every call also carries an exit code and timing in _meta, and errors come back as results rather than transport failures. See Results.

automation_create

Hints — writes (no read-only or destructive hint) Create an automation. Creates an automation on exactly one of canvas or workspace. Instructions come from instructions. Scheduling is one of three shapes:
  • cron recurring, on that cadence, interpreted in tz (an IANA zone; the server default applies when omitted)
  • run_at one-off, a single run at that RFC 3339 instant and no cadence
  • neither on-demand only: it runs when triggered with automation_run
cron and run_at are mutually exclusive. An invalid cron or time zone is rejected with the server’s explanation. Exactly one of: canvas, workspace. At most one of: cron, run_at. Returns — JSON, as text content and as structured content.

automation_delete

Hints — destructive Delete an automation. Deletes an automation permanently: its cadence stops and it can no longer be run. Past runs are chats and survive. Deleting an already-deleted automation also succeeds. Returns — JSON, as text content and as structured content.

automation_edit

Hints — destructive Edit an automation. Edits an automation. Only the properties passed are sent; everything else is left unchanged. Setting cron "" clears the cadence entirely, making the automation on-demand only — to stop scheduled runs while keeping the cadence, use automation_pause instead. run_at schedules a single run at that RFC 3339 instant, which is also how a one-off that has already fired or been paused is re-armed. Setting run_at "" clears the pending run, exactly like pause. Only the automation’s owner can edit it; the server rejects anyone else. Returns — JSON, as text content and as structured content.

automation_get

Hints — read-only, idempotent Show one automation. Shows one automation in full, including its instructions. The state derives from the stored cadence: active (a next run is scheduled), paused (a cadence is stored but nothing is scheduled), or on demand (no cadence). When the scheduler skipped the most recent firing, the reason and time are shown. Returns — JSON, as text content and as structured content.

automation_list

Hints — read-only, idempotent List automations. Lists automations. With no filter, lists the signed-in account’s own automations across every canvas and workspace. With canvas or workspace, lists every owner’s automations on that one resource (ones the account does not own are read-only). At most one of: canvas, workspace. Returns — JSON, as text content and as structured content.

automation_pause

Hints — destructive, idempotent Pause an automation’s scheduled runs. Pauses an automation: the pending run is cancelled while the cron cadence stays stored, so automation_resume picks the schedule back up without re-entering it. On a one-off (a run-at instant, no cron cadence) there is nothing to resume from: pausing cancels the single pending run outright. Re-arm it with automation_edit run_at. Returns — JSON, as text content and as structured content.

automation_resume

Hints — idempotent Resume a paused automation. Resumes a paused automation by re-submitting its stored cron cadence, which makes the platform compute the next run time. Resuming needs a cadence to recompute from, so it does not apply to a one-off or an on-demand automation — schedule those with automation_edit run_at or automation_edit cron. Returns — JSON, as text content and as structured content.

automation_run

Hints — destructive Run an automation now. Starts a run immediately, outside any cadence. The run executes asynchronously in a new chat (flow session) — the session id comes back right away, without waiting for the run to finish. The scheduler’s fire-time gates still apply: an archived or missing target canvas or workspace rejects the run, which exits 1 (error) with the platform’s explanation; a billing denial exits 6 (payment required). Returns — JSON, as text content and as structured content.

automation_runs

Hints — read-only, idempotent List an automation’s runs. Lists an automation’s runs, newest first — scheduled firings and automation_run triggers alike. Each run is a chat (flow session); read one in full with chat_get. Page with before using the previous page’s pagination next_ts. Owner-only. Returns — JSON, as text content and as structured content.