Skyvern: Create a schedule for an agent

Skyvern schedules.createWorkflowSchedule: arguments, response, policy and SDK examples.

Operation skyvern.schedules_create

Provider route: POST /v1/agents/{workflow_permanent_id}/schedules. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["schedules"]["createWorkflowSchedule"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.schedules.createWorkflowSchedule(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.schedules.create_workflow_schedule(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.workflow_permanent_id`	string	Required within parent
`body`	Model	Required within parent	Expand Update an agent schedule — request body — body

Referenced models: Update an agent schedule — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Enable an agent schedule — response body

Referenced models: Enable an agent schedule — response body

Schemas

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

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

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

Policy, approvals and errors

SDK function policy ID: skyvern.schedules_create. Catalog operation: schedules_create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page