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.

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

Changed in 4 of the 101 revisions of this API.212

Sep 27, 20264cb8e84f79f24See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 25, 20267989ab3e2c0326See the full diff
- ▲
  the response property / became optional for the status
  response-property-became-optional
- ▲
  response property schedule/cron_expression list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became optional
  request-property-became-optional
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jul 12, 20263c39ee1fef001See the full diff
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
Jun 8, 20263a3616091b661See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history