Get a schedule
One schedule’s rules and its run history. The read for ‘is this firing, and what did it do?’
spec, its state, and its run history in info.
info is not gated here. Unlike the list, where nextFireAt needs includeInfo=true, the single-schedule read returns the full info on every call.
The history grows as it runs
A fresh schedule carriescreatedBy, nextFireAt, and totalFires. The rest of info appears as the schedule does things:
lastObjectiveId is the fastest jump to what the last run did. lastSkipReason explains a schedule that reads STATE_ACTIVE but produces nothing, the two usual reasons being OVERLAP_POLICY_SKIP catching a still-running previous objective, and an unpublished agent.
Fetch by your own ID
Schedules take an external ID:404. To see the objectives a schedule created, filter the objective list by agentScheduleId.
Related
Create a schedule
info field explained.List schedules
nextFireAt needs includeInfo.List objectives
agentScheduleId to see what fired.Schedule an agent
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"
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.