Archive a schedule
Retire a schedule for good. One-way: an archived schedule cannot come back.
Archiving is terminal
STATE_ARCHIVED is a one-way door. An archived schedule never fires, and it cannot be resumed, paused, or updated, all three return a 400. When you want a schedule like it back, create a new one.
Choose archive over pause when you are finished with a cadence and want it out of the active set but on the record. Choose pause when you might turn it back on. You can still delete an archived schedule to drop it entirely.
Related
Pause a schedule
Delete 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
Archive 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.