Skip to main content
POST
Create a schedule

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json
deliver_to
object
required
name
string
required
prompt
string
required
trigger
object
required
agent_id
string<uuid> | null
delivery_locale
string | null

Optional BCP-47 locale override for this schedule's deliveries. Falls back to the owner's workspace_users.locale when absent.

description
string | null
max_duration_secs
integer<int32> | null

Wall-clock cap per fire, in seconds (default 1800, clamped 60..=3600). A fire that runs past it is killed and marked failed; size it for the schedule's step budget.

max_steps
integer<int32> | null

Per-turn step budget (max tool-call rounds) for each fire. Omit for the default of 200 - the same ceiling an interactive turn gets. Raise for heavy multi-step schedules; clamped 1..=1000 at fire time.

Required range: x >= 0
reset_each_fire
boolean | null

Response

Created

schedule
object
required