Sign in
schedules

Pause a scheduled agent

Pause a scheduled agent. The agent will not run until resumed.

post/agent/schedules/{scheduleId}/pause

Path parameters

scheduleIdstring required

The unique identifier of the scheduled agent

Response

Scheduled agent paused successfully

idstring required

Unique identifier for the scheduled agent

namestring required

Human-readable name for the schedule

cron_schedulestring required

Cron expression defining when the agent runs (e.g., "0 9 * * *" for daily at 9am UTC)

enabledboolean required

Whether the schedule is currently active

promptstring required

The prompt/instruction for the agent to execute

last_spawn_errorstring nullable

Error message from the last failed spawn attempt, if any

agent_uidstring uuid

UID of the agent that this schedule runs as

metadataRunMetadata

Custom key/value metadata attached to a run at creation time and immutable afterward. At most 20 keys. Keys are 1-64 bytes matching [a-zA-Z0-9._-]+ (case-sensitive); values are 0-256 bytes of UTF-8 and cannot contain NUL characters. Requests with invalid metadata are rejected. A run's effective metadata is merged per key at creation: explicit request keys override keys inherited from the parent run, which override automatic keys (ticket_id and ticket_source on Linear- and Jira-triggered runs).

created_atstring date-time required

Timestamp when the schedule was created (RFC3339)

updated_atstring date-time required

Timestamp when the schedule was last updated (RFC3339)

Changes