SKskyvern-ai
Schedules

Create a schedule for an agent

Changed on

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

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/agents/{workflow_permanent_id}/schedules
  • Auth
    API key in header x-api-key

Path parameters

workflow_permanent_idstring required

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

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • 4f792fbd8b47Revision changes
    • info

      added the optional property / to the response with the status