Schedules
Get Run Schedule
Get a run schedule by its id.
get/agents/{agent_id}/schedules/{schedule_id}
Path parameters
agent_idstring required
schedule_idstring required
Response
Successful Response
idstring required
The unique identifier of the run schedule.
agent_idstring required
The agent this schedule belongs to.
namestring required
Human-readable schedule name.
descriptionstring nullable
Optional description.
cron_expressionstring nullable
Cron cadence, if cron-based.
interval_secondsinteger nullable
Interval cadence in seconds, if interval-based.
timezonestring
Timezone the cron expression is evaluated in.
start_atstring date-time nullable
Schedule activation time.
end_atstring date-time nullable
Schedule deactivation time.
pausedboolean
Whether the schedule is paused.
task_paramsobject nullable
Task params at fire time.
task_metadataobject nullable
Task metadata at fire time.
initial_input_methodstring required
Delivery method, inferred from the agent's ACP type.
created_atstring date-time nullable
When the schedule was created.
updated_atstring date-time nullable
When the schedule was updated.
state'ACTIVE' | 'PAUSED'
Live state of a run schedule, derived from Temporal.
next_action_timesstring[]
Upcoming scheduled fire times.
skipped_action_timesstring[]
Skipped one-off scheduled fire times.
last_action_timestring date-time nullable
When the schedule last fired.
num_actions_takeninteger
Number of times the schedule has fired.