v2

latestOpenAPI 3.1.02026-08-014610794.4 KB

schedules

Create Schedule

post/api/v1/workspaces/{workspace_id}/schedules

Path parameters

workspace_idstring uuid4 required

Request body

namestring

host'SELF' | 'ASKUI'

runner_idsstring[]

tagsstring[]

started_atstring date-time

Timestamp after which the schedule starts. If not specified, the schedule starts immediately.

ended_atstring date-time nullable

ended_afterinteger nullable

Number of runs (more specifically, completions) after which the schedule ends, i.e., no more runs will be scheduled. If both ended_at and ended_after are specified, the schedule will end when either condition is met. If neither is specified, the schedule will run indefinitely.

schedulestring nullable

Cron expression specifying the schedule. If not specified, the schedule will run once on when started_at is reached which is now by default. end_at and ended_after will be ignored if schedule is not specified.

workflowsstring[] nullable

List of paths (not starting with '/' but relative to root of workspace) of workflows to be executed. Each string is a syntactically valid s3 object key or prefix. Cannot be empty. Strings starting with '.' will be ignored.

dataobject

Arbitrary data to be stored with the schedule which is made available to the runner when executing AskUI workflows.

Response

Successful Response

idstring

created_atstring date-time

namestring required

status'ACTIVE' | 'SUSPENDED' | 'ENDED'

started_atstring date-time required

ended_atstring date-time nullable

schedulestring nullable

ended_afterinteger nullable

runs_countinteger