Skip to main content
GET
JavaScript
Read one schedule: its cadence in 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 carries createdBy, 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:
A missing ID is a 404. To see the objectives a schedule created, filter the objective list by agentScheduleId.

Create a schedule

The rules, the overlap policy, and every info field explained.

List schedules

Every schedule on the agent, where nextFireAt needs includeInfo.

List objectives

Filter by agentScheduleId to see what fired.

Schedule an agent

The hands-on lesson.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

agentId
string
required

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

Example:

"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"

id
string
required

Schedule ID. Accepts the canonical as_… form or the external_id:<value> form.

Example:

"as_01HXKD2E5NQM3T9AYWCFMZZZBD"

Response

OK

AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence.

metadata
object
required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

spec
object
required

AgentScheduleSpec is the user-provided configuration for a schedule.

state
enum<string>
required
read-only

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.

Available options:
STATE_UNSPECIFIED,
STATE_ACTIVE,
STATE_PAUSED,
STATE_ARCHIVED
info
object

AgentScheduleInfo provides read-only runtime data about a schedule.