TasksEndpointsAgent

Run a workflow

Run a workflow

Headers

x-api-keystringOptional
x-max-steps-overrideintegerOptional
x-user-agentstringOptional
authorizationstringOptional

Query parameters

templatebooleanOptionalDefaults to false

Request

This endpoint expects an object.
workflow_idstringRequired

ID of the workflow to run

titlestringOptional

Optional title for this workflow run

parametersmap from strings to anyOptional

Parameters to pass to the workflow

proxy_locationenumOptional

Location of proxy to use for this workflow run

webhook_urlstringOptional

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

totp_urlstringOptional

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

totp_identifierstringOptional

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

browser_session_idstringOptional

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

Response

Successfully run workflow

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 workflow run

Errors