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 WorkerScheduleObject struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleObjectBudgetLow WorkerScheduleObjectBudget = "low"

const WorkerScheduleObjectBudgetStandard WorkerScheduleObjectBudget = "standard"

const WorkerScheduleObjectBudgetHigh WorkerScheduleObjectBudget = "high"

const WorkerScheduleObjectBudgetUnlimited WorkerScheduleObjectBudget = "unlimited"

Input string

NextRunAt Time

formatdate-time

Type string

type WorkerScheduleObject struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleObjectBudgetLow WorkerScheduleObjectBudget = "low"

const WorkerScheduleObjectBudgetStandard WorkerScheduleObjectBudget = "standard"

const WorkerScheduleObjectBudgetHigh WorkerScheduleObjectBudget = "high"

const WorkerScheduleObjectBudgetUnlimited WorkerScheduleObjectBudget = "unlimited"

DelayInSeconds int64

Input string

NextRunAt Time

formatdate-time

Type string

type WorkerScheduleObject struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleObjectBudgetLow WorkerScheduleObjectBudget = "low"

const WorkerScheduleObjectBudgetStandard WorkerScheduleObjectBudget = "standard"

const WorkerScheduleObjectBudgetHigh WorkerScheduleObjectBudget = "high"

const WorkerScheduleObjectBudgetUnlimited WorkerScheduleObjectBudget = "unlimited"

Cron string

Input string

NextRunAt Time

formatdate-time

Type string

type WorkerScheduleObject struct{…}

ID string

Budget string

One of the following:

const WorkerScheduleObjectBudgetLow WorkerScheduleObjectBudget = "low"

const WorkerScheduleObjectBudgetStandard WorkerScheduleObjectBudget = "standard"

const WorkerScheduleObjectBudgetHigh WorkerScheduleObjectBudget = "high"

const WorkerScheduleObjectBudgetUnlimited WorkerScheduleObjectBudget = "unlimited"

Input string

IntervalSeconds int64

NextRunAt Time

formatdate-time

Type string