Endpoints
All endpoints are organization-scoped and require the
X-Organization-Id header. Mutations additionally require an admin or owner role, because a run costs compute and can post to a shared channel.
Validate before you enable
POST /{agent_id}:run executes the identical code path the scheduled tick takes — same template resolution, same Slack target, same orchestrator call. A misconfigured agent fails there, synchronously, with the reason in the response, instead of silently at its scheduled hour.
It works on disabled agents, which makes this the recommended order:
Cron is 5 fields, in UTC
Schedules run inEtc/UTC. There is no per-agent time zone, so a local time has to be converted by hand and revisited when daylight saving shifts.
The
next_run_at field on every response is derived from the cron, so it is the fastest way to confirm a schedule reads the way you meant. It is null for disabled agents, which have no scheduler job at all.
next_run_at is advisory. Cloud Scheduler owns the real timing; this is a convenience so you don’t need a separate lookup.The scheduled agent object
string
Scheduled agent ID.
string
Display name (1–128 characters).
string
5-field cron expression, evaluated in UTC.
string
Prompt run on every tick.
string | null
Org template the session launches from.
string | null
Display name of that template.
string
Coding agent to run (default
claude-code).string | null
Model override for the launched session.
boolean
Whether the schedule is live. Disabling removes the scheduler job but keeps the agent.
string | null
Slack integration posting the result. Travels with
slack_channel_id; setting one without the other is a 400.string | null
Display name of that integration.
string | null
Channel the result is posted to.
string | null
When the agent last ran, scheduled or manual.
string | null
Session created by that run. Inspect it with Get Session.
string | null
Next UTC fire time derived from the cron.
null when disabled or when the expression can’t be parsed.string
Creation timestamp.
string | null
Last modification timestamp.