Create Schedule

Create a new schedule for recurring workflow execution for an agent.

agent_idstring required

Request body

namestring required

Human-readable name for the schedule (e.g., 'weekly-profiling'). Will be combined with agent_id to form the full schedule_id.

workflow_namestring required

Name of the Temporal workflow to execute (e.g., 'sae-orchestrator')

task_queuestring required

Temporal task queue where the agent's worker is listening

workflow_paramsobject nullable

Parameters to pass to the workflow

cron_expressionstring nullable

Cron expression for scheduling (e.g., '0 0 * * 0' for weekly on Sunday)

interval_secondsinteger nullable

Alternative to cron - run every N seconds

execution_timeout_secondsinteger nullable

Maximum time in seconds for each workflow execution

start_atstring date-time nullable

When the schedule should start being active

end_atstring date-time nullable

When the schedule should stop being active

pausedboolean

Whether to create the schedule in a paused state

Successful Response

schedule_idstring required

Unique identifier for the schedule

namestring required

Human-readable name for the schedule

agent_idstring required

ID of the agent this schedule belongs to

state'ACTIVE' | 'PAUSED' required

Schedule state enum

num_actions_takeninteger

Number of times the schedule has executed

num_actions_missedinteger

Number of scheduled executions that were missed

next_action_timesstring[]

Upcoming scheduled execution times

last_action_timestring date-time nullable

When the schedule last executed

created_atstring date-time nullable

When the schedule was created