Skip to content

Documentation index: llms.txt. Read this chapter as Markdown.

Tasks and schedules

A Task is a saved brief, not an execution. A schedule can create future work but does not supply an executor or bypass approvals. Read the current Task and Schedule before editing; disabling future occurrences does not cancel an existing Run. Read the Runs guide for the workflow.

List Tasks

swarm_list_tasks

Read one bounded page of Task briefs in a Space.

Required
None
Optional
space_idlimitcursororder
Effect
read
Capability
space.read

Get Task

swarm_get_task

Read one Task brief.

Required
task_id
Optional
None
Effect
read
Capability
space.read

Save Task

swarm_create_task

Save a planning brief in an approved Space. This does not launch execution.

Required
titledescriptionidempotency_key
Optional
space_idrun_requirements
Effect
control
Capability
space.operate

Update Task

swarm_update_task

Edit a Task before its Runs execute.

Required
task_idtitledescriptionidempotency_key
Optional
run_requirementsexpected_updated_at
Effect
control
Capability
space.operate

Cancel Task

swarm_cancel_task

Cancel a Task and its pending Runs before leasing or execution.

Required
task_ididempotency_key
Optional
reason
Effect
control
Capability
space.operate

List Schedules

swarm_list_schedules

Read one bounded page of schedules in a Space.

Required
None
Optional
space_idlimitcursororderactive_only
Effect
read
Capability
space.read

Get Schedule

swarm_get_schedule

Read one saved schedule. A saved schedule does not prove execution completed.

Required
policy_id
Optional
None
Effect
read
Capability
space.read

Schedule Task

swarm_create_schedule

Create requested scheduled work. schedule.once uses run_at; schedule.interval uses start_at and interval_seconds (60 to 31536000). Timestamps require RFC3339 with timezone. Uses normal execution settings, credits and approvals; missed intervals coalesce.

Required
nametrigger_keytrigger_configtarget_task_ididempotency_key
Optional
space_idexecution_policy_idcore_idrun_requirements
Effect
control
Capability
space.operate

Update Schedule

swarm_update_schedule

Replace the timing and Task of a schedule in its approved Space. Supply the complete configuration. Uses normal execution settings, credits and approvals.

Required
policy_idnametrigger_keytrigger_configtarget_task_ididempotency_key
Optional
execution_policy_idcore_idrun_requirements
Effect
control
Capability
space.operate

Stop Schedule

swarm_disable_schedule

Stop future occurrences. Existing Runs are unchanged.

Required
policy_ididempotency_key
Optional
None
Effect
control
Capability
space.operate
Swarm | Tasks and schedules