Skip to main content
POST
Start cloud runs of an agent from Console events. Requires --execute unless --disabled.

Body

application/json
agent
string
required

Library agent slug, or a cloud agent id or name

base
string

Bases: only this base

batchWindow
string

Wait this long to batch events (0-3600, default 60)

budget
string

Budget per run in US dollars (default: the agent's)

dailyCap
string

Runs per day at most (1-200, default 20)

dedupeWindow
string

Drop repeats of an event within (default 600)

deliverTo
string

Session that gets each result, or none

disabled
boolean

Create it disabled (applies at once)

events
string[]

Only these event types (comma-separated or repeated)

execute
boolean

Create an enabled trigger (without it, print the plan and exit 3)

mailbox
string

Mail: only this mailbox

project
string

Console project slug (default: the cwd's project)

prompt
string

What each run does; {{event}} is where the events go

site
string

Page comments: only this site

source
string

bases, mail, meetings or pages_comments

view
string

Bases: only rows of this view

Response

Success — body conforms to the @Returns schema.

success
boolean
required
trigger
object
required