trigger_schedule
Run a schedule once, immediately, without waiting for its next slot.
This spends a real agent or workflow run. The dispatch is asynchronous — poll
get_schedule for the run’s status, then read the result
with get_assistant_run (agent target, via the run’s
thread_id) or get_run_status (workflow target, via
agent_run_id).
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
schedule_id | string | yes | The schedule id |
Returns#
json
{
"triggered": true,
"schedule_id": "sched_abc123",
"run_id": "sched_run_xyz",
"status": "pending",
"note": "Dispatched asynchronously. Poll get_schedule: once this run_id shows a thread_id ..."
}run_id is the run just dispatched (created pending, then picked up by the
worker) — not the previous one.
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
feature_not_available | Your plan does not include schedules |
not_found | Unknown schedule id, or one outside your organization |