Skip to main content

Documentation Index

Fetch the complete documentation index at: https://skyvern.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

List workflow runs across all workflows for the current organization. Results are paginated and can be filtered by status, search key, and error code. 
runs = await client.get_workflow_runs(page=1, page_size=10)
for run in runs:
    print(run.workflow_run_id, run.status)

​
Parameters

ParameterTypeRequiredDescription
pageintNoPage number (1-indexed).
page_sizeintNoResults per page.
statusWorkflowRunStatus | list[WorkflowRunStatus]NoFilter by run status.
search_keystrNoCase-insensitive substring search (min 3 chars). Matches against run ID, parameter keys, parameter values, and descriptions.
error_codestrNoFilter by error code.
request_optionsRequestOptionsNoPer-request configuration (see below).

​
Returns list[WorkflowRun]

​
Request options

Override timeout, retries, or headers for this call by passing request_options (Python) or a second options argument (TypeScript). 
from skyvern.client.core import RequestOptions

request_options=RequestOptions(
    timeout_in_seconds=120,
    max_retries=3,
    additional_headers={"x-custom-header": "value"},
)
Option (Python)Option (TypeScript)TypeDescription
timeout_in_secondstimeoutInSecondsint / numberHTTP timeout in seconds.
max_retriesmaxRetriesint / numberRetry count.
additional_headersheadersdict / Record<string, string>Extra headers.
additional_query_parameters-dictExtra query parameters.
additional_body_parameters-dictExtra body parameters.
-abortSignalAbortSignalSignal to cancel the request.
-apiKeystringOverride API key.