Schedule a Workbench flow
workbench_flows_scheduleSet a specific built flow to run automatically on a cadence — the deterministic counterpart to a zv1 routine. Each run executes the flow's latest PUBLISHED revision with the fixed input envelope and routes the output per delivery. USE THIS when the user wants a flow they've built to run on a schedule ("run my digest flow every morning"). Do NOT create a routine for this — a routine runs a free-form instruction, not a built flow. The schedule runs the PUBLISHED flow, so the flow must be published (check workbench_flows_revisions_list; publish with workbench_flows_publish if it isn't). input is fixed for every run, so the flow itself should fetch anything time-varying at run time. Manage existing schedules with workbench_flows_schedules_list / workbench_flows_schedules_update.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes | Fixed input envelope every run executes with — {"kind":"chat","messages":[…]} or {"kind":"form","values":{…}}, the same shape workbench_flows_run takes. Constant across runs. | |
| label | No | ||
| flowId | Yes | Flow to schedule (id from workbench_flows_list). | |
| delivery | No | ||
| interval | Yes | Cadence: hourly, daily, or weekly. | |
| workspace | No | Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys. | |
| approvalId | No | Approval id from a prior needs_confirmation response. Omit on the first call. | |
| scheduleTime | No | ||
| scheduleTimezone | No | ||
| scheduleDayOfWeek | No |