Skip to main content
POST
Schedule cloud runs of an agent on a cron. Requires --execute unless --disabled.

Body

application/json
agent
string
required

Library agent slug, or a cloud agent id or name

budget
string

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

cron
string

Five cron fields, such as "0 9 * * 1-5"

disabled
boolean

Create it disabled (applies at once)

execute
boolean

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

project
string

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

prompt
string

What each run does (default: the agent's HEARTBEAT.md)

timezone
string

IANA time zone (default: this machine's)

Response

Success — body conforms to the @Returns schema.

schedule
object
required
success
boolean
required