Skyvern: Schedules schemas
7 Skyvern schemas with complete fields and constraints.
← Schedules operations · All schemas
Delete an agent schedule — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ok | boolean | Required within parent |
Enable an agent schedule — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next_runs | array | Optional | |
next_runs[] | string | Each item | Format: date-time |
schedule | Model | Required within parent | Expand Enable an agent schedule — response body — schedule |
Referenced models: Enable an agent schedule — response body — schedule
Enable an agent schedule — response body — schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Format: date-time |
created_by | JSON | Optional | Who the schedule runs as; null for schedules created before owners were recorded. |
created_by (anyOf 1) | string | Alternative | |
created_by (anyOf 2) | null | Alternative | |
cron_expression | JSON | Optional | |
cron_expression (anyOf 1) | string | Alternative | |
cron_expression (anyOf 2) | null | Alternative | |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
dispatch_status | JSON | Optional | |
dispatch_status (anyOf 1) | string | Alternative | Known values: pending, fired, canceled, failed |
dispatch_status (anyOf 2) | null | Alternative | |
enabled | boolean | Required within parent | |
first_fire_at | JSON | Optional | |
first_fire_at (anyOf 1) | string | Alternative | Format: date-time |
first_fire_at (anyOf 2) | null | Alternative | |
interval_seconds | JSON | Optional | |
interval_seconds (anyOf 1) | JSON | Alternative | |
interval_seconds (anyOf 1) (anyOf 1) | integer | Alternative | |
interval_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interval_seconds (anyOf 2) | null | Alternative | |
modified_at | string | Required within parent | Format: date-time |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
organization_id | string | Required within parent | |
parameters | JSON | Optional | |
parameters (anyOf 1) | object | Alternative | Additional keys: allowed |
parameters (anyOf 2) | null | Alternative | |
run_at | JSON | Optional | |
run_at (anyOf 1) | string | Alternative | Format: date-time |
run_at (anyOf 2) | null | Alternative | |
temporal_schedule_id | JSON | Optional | |
temporal_schedule_id (anyOf 1) | string | Alternative | |
temporal_schedule_id (anyOf 2) | null | Alternative | |
timezone | string | Required within parent | |
workflow_permanent_id | string | Required within parent | |
workflow_run_id | JSON | Optional | |
workflow_run_id (anyOf 1) | string | Alternative | |
workflow_run_id (anyOf 2) | null | Alternative | |
workflow_schedule_id | string | Required within parent |
List all schedules for the organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page_size | JSON | Required within parent | |
page_size (anyOf 1) | integer | Alternative | |
page_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schedules | array | Required within parent | |
schedules[] | Model | Each item | Expand List all schedules for the organization — response body — schedules item |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List all schedules for the organization — response body — schedules item
List all schedules for the organization — response body — schedules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compact schedule projection for the org-wide list endpoint. Intentionally omits `backend_schedule_id` — the list view is for browsing schedules in the dashboard, not for managing the underlying execution-backend binding. Callers that need the backend id should fetch the individual schedule via the per-workflow get endpoint. |
created_at | string | Required within parent | Format: date-time |
cron_expression | JSON | Optional | |
cron_expression (anyOf 1) | string | Alternative | |
cron_expression (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
dispatch_status | JSON | Optional | |
dispatch_status (anyOf 1) | string | Alternative | Known values: pending, fired, canceled, failed |
dispatch_status (anyOf 2) | null | Alternative | |
enabled | boolean | Required within parent | |
first_fire_at | JSON | Optional | |
first_fire_at (anyOf 1) | string | Alternative | Format: date-time |
first_fire_at (anyOf 2) | null | Alternative | |
interval_seconds | JSON | Optional | |
interval_seconds (anyOf 1) | JSON | Alternative | |
interval_seconds (anyOf 1) (anyOf 1) | integer | Alternative | |
interval_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interval_seconds (anyOf 2) | null | Alternative | |
modified_at | string | Required within parent | Format: date-time |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
next_run | JSON | Optional | |
next_run (anyOf 1) | string | Alternative | Format: date-time |
next_run (anyOf 2) | null | Alternative | |
organization_id | string | Required within parent | |
parameters | JSON | Optional | |
parameters (anyOf 1) | object | Alternative | Additional keys: allowed |
parameters (anyOf 2) | null | Alternative | |
run_at | JSON | Optional | |
run_at (anyOf 1) | string | Alternative | Format: date-time |
run_at (anyOf 2) | null | Alternative | |
timezone | string | Required within parent | |
workflow_permanent_id | string | Required within parent | |
workflow_run_id | JSON | Optional | |
workflow_run_id (anyOf 1) | string | Alternative | |
workflow_run_id (anyOf 2) | null | Alternative | |
workflow_schedule_id | string | Required within parent | |
workflow_title | string | Required within parent |
List schedules for an agent — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
schedules | array | Required within parent | |
schedules[] | Model | Each item | Expand Enable an agent schedule — response body — schedule |
Referenced models: Enable an agent schedule — response body — schedule
Update an agent schedule — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cron_expression | JSON | Optional | |
cron_expression (anyOf 1) | string | Alternative | |
cron_expression (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
enabled | JSON | Optional | Default: true |
enabled (anyOf 1) | boolean | Alternative | |
enabled (anyOf 2) | null | Alternative | |
first_fire_at | JSON | Optional | First run of an interval schedule; later runs follow every interval_seconds from it. Must be in the future when changed. Defaults to one interval after creation. |
first_fire_at (anyOf 1) | string | Alternative | Format: date-time |
first_fire_at (anyOf 2) | null | Alternative | |
interval_seconds | JSON | Optional | Fixed elapsed interval between runs, in seconds. Mutually exclusive with cron_expression. |
interval_seconds (anyOf 1) | integer | Alternative | Maximum: 2147483647.0 Minimum: 300.0 |
interval_seconds (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
parameters | JSON | Optional | |
parameters (anyOf 1) | object | Alternative | Additional keys: allowed |
parameters (anyOf 2) | null | Alternative | |
run_at | JSON | Optional | Run the agent once at this instant, ISO 8601 with a UTC offset, at least 60 seconds in the future. Mutually exclusive with cron_expression and interval_seconds; the schedule can be edited or canceled only until it fires. |
run_at (anyOf 1) | string | Alternative | Format: date-time |
run_at (anyOf 2) | null | Alternative | |
timezone | string | Required within parent |