API ReferenceAgent

Run a task

Run a task

Headers

x-api-keystringOptional
x-user-agentstringOptional
authorizationstringOptional

Request

This endpoint expects an object.
promptstringRequired

The goal or task description for Skyvern to accomplish

urlstringOptional

The starting URL for the task. If not provided, Skyvern will attempt to determine an appropriate URL

titlestringOptional

Optional title for the task

engineenumOptional

The Skyvern engine version to use for this task

Allowed values:
proxy_locationenumOptional

Geographic Proxy location to route the browser traffic through

data_extraction_schemamap from strings to any or list of any or stringOptional

Schema defining what data should be extracted from the webpage

error_code_mappingmap from strings to optional stringsOptional

Custom mapping of error codes to error messages if Skyvern encounters an error

max_stepsintegerOptional

Maximum number of steps the task can take before timing out

webhook_urlstringOptional

URL to send task status updates to after a run is finished

totp_identifierstringOptional

Identifier for TOTP (Time-based One-Time Password) authentication if codes are being pushed to Skyvern

totp_urlstringOptional

URL for TOTP authentication setup if Skyvern should be polling endpoint for 2FA codes

browser_session_idstringOptional

ID of an existing browser session to reuse, having it continue from the current screen state

publish_workflowbooleanOptionalDefaults to false

Whether to publish this task as a reusable workflow.

Response

Successfully run task

run_idstring

Unique identifier for this run

statusenum

Current status of the run

created_atdatetime

Timestamp when this run was created

modified_atdatetime

Timestamp when this run was last modified

outputmap from strings to any or list of any or stringOptional

Output data from the run, if any. Format depends on the schema in the input

downloaded_fileslist of objectsOptional

List of files downloaded during the run

recording_urlstringOptional

URL to the recording of the run

failure_reasonstringOptional

Reason for failure if the run failed

run_requestobjectOptional

The original request parameters used to start this task run

Errors