Get started

Schedulers

Schedulers

Create and manage Scheduler projects from the API: set the schedule, pause or resume it, and trigger runs on demand.

POST/organizations/:orgId/projects

Create a Scheduler project. It starts on a default hourly schedule (UTC); change it with the schedule endpoint below.

Request body
{
  "name": "nightly-report",
  "type": "cron"
}
Response
{
  "project": {
    "id": "p1234567-abcd-...",
    "name": "nightly-report",
    "description": null,
    "region": "us-east-1",
    "type": "cron",
    "schedule": "0 * * * *",
    "timezone": "UTC",
    "scheduleEnabled": true,
    "createdAt": "2026-07-09T...",
    "updatedAt": "2026-07-09T..."
  }
}
PUT/organizations/:orgId/projects/:projectId/schedule

Update the schedule, timezone, or paused state β€” send any subset of the three fields. The schedule field takes a standard cron expression (5 fields).

Request body
{
  "schedule": "0 9 * * MON-FRI",
  "timezone": "America/New_York",
  "enabled": true
}
Response
{
  "project": {
    "id": "p1234567-abcd-...",
    "type": "cron",
    "schedule": "0 9 * * MON-FRI",
    "timezone": "America/New_York",
    "scheduleEnabled": true,
    "updatedAt": "2026-07-09T..."
  }
}
POST/organizations/:orgId/projects/:projectId/run

Trigger a run immediately, outside the schedule. The invocation is asynchronous β€” check Logs for output.

Response
{
  "invoked": true
}