Trigger Schedule

Trigger a schedule to run immediately, regardless of its regular schedule.

POST /agents/{agent_id}/schedules/{schedule_name}/trigger

Trigger Schedule

cURL

curl --request POST \
  --url https://api.example.com/agents/{agent_id}/schedules/{schedule_name}/trigger

200

{
  "schedule_id": "<string>",
  "name": "<string>",
  "agent_id": "<string>",
  "action": {
    "workflow_name": "<string>",
    "workflow_id_prefix": "<string>",
    "task_queue": "<string>",
    "workflow_params": [
      "<unknown>"
    ]
  },
  "spec": {
    "cron_expressions": [
      "<string>"
    ],
    "intervals_seconds": [
      123
    ],
    "start_at": "2023-11-07T05:31:56Z",
    "end_at": "2023-11-07T05:31:56Z"
  },
  "num_actions_taken": 0,
  "num_actions_missed": 0,
  "next_action_times": [
    "2023-11-07T05:31:56Z"
  ],
  "last_action_time": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Path Parameters

schedule_name · string · required

agent_id · string · required

Response

200

application/json

Successful Response

Response model for schedule operations

schedule_id · string · required

Unique identifier for the schedule

name · string · required

Human-readable name for the schedule

agent_id · string · required

ID of the agent this schedule belongs to

state · enum<string> · required

Current state of the schedule

Available options: ACTIVE, PAUSED

action · Action · object · required

Information about the scheduled action

Show child attributes

spec · Spec · object · required

Schedule specification

Show child attributes

num_actions_taken · integer · default: 0

Number of times the schedule has executed

num_actions_missed · integer · default: 0

Number of scheduled executions that were missed

next_action_times · string<date-time>[]

Upcoming scheduled execution times

last_action_time · string<date-time> | null

When the schedule last executed

created_at · string<date-time> | null

When the schedule was created