Endpoints
Schedules
Create, list, change, pause and delete the scheduled runs of your flows.
The same schedules as Agenda › Scheduled Runs in the app. See Scheduled runs.
Create a schedule
POST /api/schedules/curl -X POST "https://app.chainz.waiyers.com/api/schedules/" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"flow_id": "'"$FLOW_ID"'",
"schedule_type": "recurring",
"cron_expression": "0 9 * * 1-5",
"timezone": "Europe/Paris",
"inputs": { "input_value": "Today'"'"'s news on solar panels" },
"max_credits": 50
}'| Field | Type | What it is |
|---|---|---|
flow_id | string | The flow to run. Required. |
schedule_type | string | once (default) or recurring. |
scheduled_at | string | For once: the date and time, ISO 8601. |
cron_expression | string | For recurring: when to run, in cron format. |
timezone | string | The timezone of the times, e.g. Europe/Paris. Default UTC. |
inputs | object | The inputs of each run. |
max_credits | integer | The most credits one run may use. |
Returns the schedule with its id and status.
List schedules
GET /api/schedules/?flow_id=…&status=…Both filters are optional.
Read, change, delete
GET /api/schedules/{schedule_id}
PATCH /api/schedules/{schedule_id}
DELETE /api/schedules/{schedule_id}PATCH takes any field of the creation body, plus status. Pause with {"status": "paused"}, resume with {"status": "active"}.
Statuses
| Status | Meaning |
|---|---|
active | Will run at its next time. |
paused | Kept, does not run. |
completed | A one-time schedule that has run. |
cancelled | Stopped for good. |
failed | Its last run failed. |
Was this page helpful?
Last updated 2026-10-13