Pause a schedule
Stop a schedule firing without losing it. Resume when you are ready.
STATE_ACTIVE to STATE_PAUSED. It stops creating objectives at once and does not fire again until you resume it. state is read-only, so this action is the only way to pause: a PATCH cannot set it.
Pausing is idempotent, so a pause on an already-paused schedule is safe. Objectives a fire already created keep running.
Related
Resume a schedule
Archive a schedule
Create a schedule
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.
"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"
Schedule ID. Accepts the canonical as_… form or the external_id:<value> form.
"as_01HXKD2E5NQM3T9AYWCFMZZZBD"
Body
Pause agent schedule request.
Response
OK
AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence.
Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
AgentScheduleSpec is the user-provided configuration for a schedule.
The current lifecycle state of the schedule. Output only. Schedules are created STATE_ACTIVE; use the :pause, :resume, and :archive actions to transition between states.
STATE_UNSPECIFIED, STATE_ACTIVE, STATE_PAUSED, STATE_ARCHIVED AgentScheduleInfo provides read-only runtime data about a schedule.