Skip to main content
POST
JavaScript
Stop a schedule from firing, keeping its rules intact so you can turn it back on.
Pausing moves the schedule from 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.

Resume a schedule

Start it firing again.

Archive a schedule

Retire it for good instead of pausing.

Create a schedule

The rules a pause leaves intact.

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"

Body

application/json

Pause agent schedule request.

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.