Sign in
Schedules

Create a schedule for an agent

Create a cron, fixed-interval or one-time schedule that runs the given agent automatically with a fixed set of parameters. An interval schedule first runs at first_fire_at, or one interval after creation. A one-time schedule runs once at run_at. Returns the stored schedule and its next upcoming run times.

post/v1/agents/{workflow_permanent_id}/schedules

Path parameters

workflow_permanent_idstring required

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

cron_expressionstring nullable
interval_secondsinteger nullable

Fixed elapsed interval between runs, in seconds. Mutually exclusive with cron_expression.

first_fire_atstring date-time nullable

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.

run_atstring date-time nullable

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.

timezonestring required
enabledboolean nullable
parametersobject nullable
namestring nullable
descriptionstring nullable

Response

Successful Response

next_runsstring[]

Changes