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

client.Workers.Schedules.List(ctx, workerID) (*WorkerScheduleListResponse, error)

GET/api/workers/{workerId}/schedules

Create a worker schedule

client.Workers.Schedules.New(ctx, workerID, body) (*WorkerScheduleUnion, error)

POST/api/workers/{workerId}/schedules

Cancel a worker schedule

client.Workers.Schedules.Cancel(ctx, scheduleID, body) (*WorkerScheduleCancelResponse, error)

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

ModelsExpand Collapse

type WorkerScheduleUnion interface{…}

One of the following:

type WorkerScheduleScheduled struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleScheduledBudgetLow WorkerScheduleScheduledBudget = "low"

const WorkerScheduleScheduledBudgetStandard WorkerScheduleScheduledBudget = "standard"

const WorkerScheduleScheduledBudgetHigh WorkerScheduleScheduledBudget = "high"

const WorkerScheduleScheduledBudgetUnlimited WorkerScheduleScheduledBudget = "unlimited"

Input string

NextRunAt Time

formatdate-time

Type Scheduled

type WorkerScheduleDelayed struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleDelayedBudgetLow WorkerScheduleDelayedBudget = "low"

const WorkerScheduleDelayedBudgetStandard WorkerScheduleDelayedBudget = "standard"

const WorkerScheduleDelayedBudgetHigh WorkerScheduleDelayedBudget = "high"

const WorkerScheduleDelayedBudgetUnlimited WorkerScheduleDelayedBudget = "unlimited"

DelayInSeconds int64

Input string

NextRunAt Time

formatdate-time

Type Delayed

type WorkerScheduleCron struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleCronBudgetLow WorkerScheduleCronBudget = "low"

const WorkerScheduleCronBudgetStandard WorkerScheduleCronBudget = "standard"

const WorkerScheduleCronBudgetHigh WorkerScheduleCronBudget = "high"

const WorkerScheduleCronBudgetUnlimited WorkerScheduleCronBudget = "unlimited"

Cron string

Input string

NextRunAt Time

formatdate-time

Type Cron

type WorkerScheduleInterval struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleIntervalBudgetLow WorkerScheduleIntervalBudget = "low"

const WorkerScheduleIntervalBudgetStandard WorkerScheduleIntervalBudget = "standard"

const WorkerScheduleIntervalBudgetHigh WorkerScheduleIntervalBudget = "high"

const WorkerScheduleIntervalBudgetUnlimited WorkerScheduleIntervalBudget = "unlimited"

Input string

IntervalSeconds int64

NextRunAt Time

formatdate-time

Type Interval