API ReferenceWorkflows

Run a workflow

Run a workflow

Headers

x-api-keystringRequired
x-max-steps-overrideintegerOptional
x-user-agentstringOptional

Query parameters

templatebooleanOptionalDefaults to false

Request

This endpoint expects an object.
workflow_idstringRequired

ID of the workflow to run. Workflow ID starts with wpid_.

parametersmap from strings to anyOptional
Parameters to pass to the workflow
titlestringOptional
The title for this workflow run
proxy_locationenumOptional

Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.

Available geotargeting options:

  • RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
  • RESIDENTIAL_ES: Spain
  • RESIDENTIAL_IE: Ireland
  • RESIDENTIAL_GB: United Kingdom
  • RESIDENTIAL_IN: India
  • RESIDENTIAL_JP: Japan
  • RESIDENTIAL_FR: France
  • RESIDENTIAL_DE: Germany
  • RESIDENTIAL_NZ: New Zealand
  • RESIDENTIAL_ZA: South Africa
  • RESIDENTIAL_AR: Argentina
  • RESIDENTIAL_ISP: ISP proxy
  • US-CA: California
  • US-NY: New York
  • US-TX: Texas
  • US-FL: Florida
  • US-WA: Washington
  • NONE: No proxy
webhook_urlstringOptional

URL to send workflow status updates to after a run is finished. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for webhook questions.

totp_urlstringOptional

URL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://docs.skyvern.com/credentials/totp#option-2-get-code-from-your-endpoint for more details.

totp_identifierstringOptional

Identifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://docs.skyvern.com/credentials/totp#option-3-push-code-to-skyvern for more details.

browser_session_idstringOptional
ID of a Skyvern browser session to reuse, having it continue from the current screen state

Response

Successfully run workflow
run_idstring

Unique identifier for this run. Run ID starts with tsk_ for task runs and wr_ for workflow runs.

statusenum
Current status of the run
created_atstringformat: "date-time"
Timestamp when this run was created
modified_atstringformat: "date-time"
Timestamp when this run was last modified
run_type"workflow_run"

Type of run - always workflow_run for workflow runs

outputmap from strings to any or list of any or string or null

Output data from the run, if any. Format/schema depends on the data extracted by the run.

downloaded_fileslist of objects or null
List of files downloaded during the run
recording_urlstring or null
URL to the recording of the run
screenshot_urlslist of strings or null

List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.

failure_reasonstring or null
Reason for failure if the run failed or terminated
app_urlstring or null
URL to the application UI where the run can be viewed
run_requestobject or null
The original request parameters used to start this workflow run

Errors