Skip to main content
POST
JavaScript
Retire a schedule you are done with, keeping its record for history.

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.

Pause a schedule

The reversible alternative.

Delete a schedule

Remove an archived schedule for good.

Create a schedule

Start a replacement.

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

Archive 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.