Skip to main content
POST
JavaScript
Restart a paused schedule so it fires again on its cadence.
Resuming moves the schedule from STATE_PAUSED back to STATE_ACTIVE. It computes the next fire from the current time forward; it does not backfill the runs that a pause skipped.

Only a paused schedule resumes

Resume works on STATE_PAUSED. Resuming an archived schedule is a 400, archiving is terminal, so create a new schedule instead. Resuming an already-active schedule is a safe no-op.

Pause a schedule

Stop it again.

List schedules

Confirm nextFireAt after resuming.

Create a schedule

Start a fresh one when the old is archived.

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

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