API Reference

Workers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Schedules

Manage future and recurring worker tasks.

List worker schedules

GET/api/workers/{workerId}/schedules

Create a worker schedule

POST/api/workers/{workerId}/schedules

Cancel a worker schedule

DELETE/api/workers/{workerId}/schedules/{scheduleId}

ModelsExpand Collapse

WorkerSchedule = object { id, budget, input, 2 more } or object { id, budget, delayInSeconds, 3 more } or object { id, budget, cron, 3 more } or object { id, budget, input, 3 more }

One of the following:

object { id, budget, input, 2 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

input: string

nextRunAt: string

formatdate-time

type: "scheduled"

object { id, budget, delayInSeconds, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

delayInSeconds: number

input: string

nextRunAt: string

formatdate-time

type: "delayed"

object { id, budget, cron, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

cron: string

input: string

nextRunAt: string

formatdate-time

type: "cron"

object { id, budget, input, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

input: string

intervalSeconds: number

nextRunAt: string

formatdate-time

type: "interval"

ScheduleListResponse object { schedules, workerId }

schedules: array of WorkerSchedule

One of the following:

object { id, budget, input, 2 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

input: string

nextRunAt: string

formatdate-time

type: "scheduled"

object { id, budget, delayInSeconds, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

delayInSeconds: number

input: string

nextRunAt: string

formatdate-time

type: "delayed"

object { id, budget, cron, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

cron: string

input: string

nextRunAt: string

formatdate-time

type: "cron"

object { id, budget, input, 3 more }

id: string

budget: "low" or "standard" or "high" or "unlimited"

One of the following:

"low"

"standard"

"high"

"unlimited"

input: string

intervalSeconds: number

nextRunAt: string

formatdate-time

type: "interval"

workerId: string

ScheduleCancelResponse object { cancelled }

cancelled: boolean