Helpers

Helpers run a purpose-built agent for a common job and return its run. Every method here also accepts request_options (Python) or a final requestOptions argument (TypeScript) to override the timeout, retries or headers for one call; see request options.

await skyvern.login(
    credential_type: CredentialType,
    *,
    url: str | None = None,
    credential_id: str | None = None,
    bitwarden_collection_id: str | None = None,
    bitwarden_item_id: str | None = None,
    onepassword_vault_id: str | None = None,
    onepassword_item_id: str | None = None,
    prompt: str | None = None,
    webhook_url: str | None = None,
    proxy_location: ProxyLocationInput = None,
    totp_identifier: str | None = None,
    totp_url: str | None = None,
    browser_session_id: str | None = None,
    browser_address: str | None = None,
    extra_http_headers: dict[str, str] | None = None,
    max_screenshot_scrolling_times: int | None = None,
    azure_vault_name: str | None = None,
    azure_vault_username_key: str | None = None,
    azure_vault_password_key: str | None = None,
    azure_vault_totp_secret_key: str | None = None,
    wait_for_completion: bool = False,
    timeout: float = 1800,
) -> WorkflowRunResponse

skyvern.login(request: LoginOptions): Promise<WorkflowRunResponse>

Parameters

CredentialType

required

Where to get the credential from

str | None

Website URLDefault: None

str | None

ID of the Skyvern credential to use for login.Default: None

str | None

Bitwarden collection ID. You can find it in the Bitwarden collection URL. e.g. https://vault.bitwarden.com/vaults/collection_id/itemsDefault: None

str | None

Bitwarden item IDDefault: None

str | None

1Password vault IDDefault: None

str | None

1Password item IDDefault: None

str | None

Webhook URL to send status updatesDefault: None

ProxyLocationInput

Proxy location to useDefault: None

str | None

Identifier for TOTP (Time-based One-Time Password) if requiredDefault: None

str | None

TOTP URL to fetch one-time passwordsDefault: None

str | None

ID of the browser session to use, which is prefixed by pbs_ e.g. pbs_123456Default: None

str | None

The CDP address for the task.Default: None

dict[str, str] | None

Additional HTTP headers to include in requestsDefault: None

int | None

Maximum number of times to scroll for screenshotsDefault: None

str | None

Azure Vault NameDefault: None

str | None

Azure Vault username keyDefault: None

str | None

Azure Vault password keyDefault: None

str | None

Azure Vault TOTP secret keyDefault: None

bool

Wait for the run to reach a final status before returning.Default: False · TypeScript: waitForCompletion

float

Maximum time to wait for completion, in seconds.Default: 1800

string

ID of a browser profile to reuse for this runTypeScript only

Record<string, string | undefined>

HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.TypeScript only

Returns WorkflowRunResponse · TypeScript Promise<WorkflowRunResponse>

WorkflowRunResponse fields

Field	Type	Description
`run_id`	`str`	Unique identifier for this run. Run ID starts with `tsk_` for task runs and `wr_` for workflow runs.
`status`	`"created" \| "queued" \| "running" \| "paused" \| "timed_out" \| "failed" \| "terminated" \| "completed" \| "canceled"`	Current status of the run
`output`	`dict[str, Any \| None] \| list[Any \| None] \| str \| None`	Output data from the run, if any. Format/schema depends on the data extracted by the run.
`downloaded_files`	`list[FileInfo] \| None`	List of files downloaded during the run
`recording_url`	`str \| None`	URL to the recording of the run
`recording_archived`	`bool \| None`	True when the recording exists but has been archived to cold storage and is not currently accessible.
`screenshot_urls`	`list[str] \| None`	List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.
`failure_reason`	`str \| None`	Reason for failure if the run failed or terminated
`created_at`	`datetime`	Timestamp when this run was created
`modified_at`	`datetime`	Timestamp when this run was last modified
`queued_at`	`datetime \| None`	Timestamp when this run was queued
`started_at`	`datetime \| None`	Timestamp when this run started execution
`finished_at`	`datetime \| None`	Timestamp when this run finished
`app_url`	`str \| None`	URL to the application UI where the run can be viewed
`browser_session_id`	`str \| None`	ID of the Skyvern persistent browser session used for this run
`browser_profile_id`	`str \| None`	ID of the browser profile used for this run
`max_screenshot_scrolls`	`int \| None`	The maximum number of scrolls for the post action screenshot. When it’s None or 0, it takes the current viewpoint screenshot
`script_run`	`ScriptRunResponse \| None`	The script run result
`errors`	`list[dict[str, Any \| None]] \| None`	The errors for the run
`step_count`	`int \| None`	Total number of steps executed in this run
`run_with`	`str \| None`	Whether the workflow run was executed with agent or code
`ai_fallback`	`bool \| None`	Whether to fallback to AI if code run fails.
`script_id`	`str \| None`	ID of the cached script used for this workflow run, if any.
`run_request`	`WorkflowRunRequestOutput \| None`	The original request parameters used to start this workflow run

Example

import asyncio

from skyvern import Skyvern
from skyvern.schemas.credential_type import CredentialType


async def main() -> None:
    skyvern = Skyvern(api_key="YOUR_API_KEY")
    result = await skyvern.login(
        credential_type=CredentialType.skyvern,
        url="https://example.com/login",
        credential_id="cred_123",
    )
    print(result)


asyncio.run(main())

import { Skyvern } from "@skyvern/client";

const skyvern = new Skyvern({ apiKey: "YOUR_API_KEY" });
const result = await skyvern.login({
    url: "https://example.com/login",
    credential_type: "skyvern",
    credential_id: "cred_123",
});
console.log(result);

download_files

Download a file from a website by navigating and clicking download buttons

await skyvern.download_files(
    *,
    navigation_goal: str,
    user_agent: str | None = None,
    url: str | None = ...,
    webhook_url: str | None = ...,
    proxy_location: ProxyLocation | None = ...,
    totp_identifier: str | None = ...,
    totp_url: str | None = ...,
    browser_session_id: str | None = ...,
    browser_profile_id: str | None = ...,
    browser_address: str | None = ...,
    extra_http_headers: dict[str, str | None] | None = ...,
    cdp_connect_headers: dict[str, str | None] | None = ...,
    max_screenshot_scrolling_times: int | None = ...,
    download_suffix: str | None = ...,
    download_timeout: float | None = ...,
    max_steps_per_run: int | None = ...,
) -> WorkflowRunResponse

skyvern.downloadFiles(request: DownloadFilesOptions): Promise<WorkflowRunResponse>

Parameters

Instructions for navigating to and downloading the file

str | None

User-Agent string the browser sends.Default: None · TypeScript: x-user-agent

str | None

Website URLSent only when you pass it

str | None

Webhook URL to send status updatesSent only when you pass it

ProxyLocation | None

Proxy location to useSent only when you pass it

str | None

Identifier for TOTP (Time-based One-Time Password) if requiredSent only when you pass it

str | None

TOTP URL to fetch one-time passwordsSent only when you pass it

str | None

ID of the browser session to use, which is prefixed by pbs_ e.g. pbs_123456Sent only when you pass it

str | None

ID of a browser profile to reuse for this runSent only when you pass it

str | None

The CDP address for the task.Sent only when you pass it

dict[str, str | None] | None

Additional HTTP headers to include in requestsSent only when you pass it

dict[str, str | None] | None

HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.Sent only when you pass it

int | None

Maximum number of times to scroll for screenshotsSent only when you pass it

str | None

Suffix or complete filename for the downloaded fileSent only when you pass it

float | None

Timeout in seconds for the download operationSent only when you pass it

int | None

Maximum number of steps to executeSent only when you pass it

boolean

TypeScript only

number

TypeScript only

Returns WorkflowRunResponse · TypeScript Promise<WorkflowRunResponse>

WorkflowRunResponse fields

Field	Type	Description
`run_id`	`str`	Unique identifier for this run. Run ID starts with `tsk_` for task runs and `wr_` for workflow runs.
`status`	`"created" \| "queued" \| "running" \| "paused" \| "timed_out" \| "failed" \| "terminated" \| "completed" \| "canceled"`	Current status of the run
`output`	`dict[str, Any \| None] \| list[Any \| None] \| str \| None`	Output data from the run, if any. Format/schema depends on the data extracted by the run.
`downloaded_files`	`list[FileInfo] \| None`	List of files downloaded during the run
`recording_url`	`str \| None`	URL to the recording of the run
`recording_archived`	`bool \| None`	True when the recording exists but has been archived to cold storage and is not currently accessible.
`screenshot_urls`	`list[str] \| None`	List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.
`failure_reason`	`str \| None`	Reason for failure if the run failed or terminated
`created_at`	`datetime`	Timestamp when this run was created
`modified_at`	`datetime`	Timestamp when this run was last modified
`queued_at`	`datetime \| None`	Timestamp when this run was queued
`started_at`	`datetime \| None`	Timestamp when this run started execution
`finished_at`	`datetime \| None`	Timestamp when this run finished
`app_url`	`str \| None`	URL to the application UI where the run can be viewed
`browser_session_id`	`str \| None`	ID of the Skyvern persistent browser session used for this run
`browser_profile_id`	`str \| None`	ID of the browser profile used for this run
`max_screenshot_scrolls`	`int \| None`	The maximum number of scrolls for the post action screenshot. When it’s None or 0, it takes the current viewpoint screenshot
`script_run`	`ScriptRunResponse \| None`	The script run result
`errors`	`list[dict[str, Any \| None]] \| None`	The errors for the run
`step_count`	`int \| None`	Total number of steps executed in this run
`run_with`	`str \| None`	Whether the workflow run was executed with agent or code
`ai_fallback`	`bool \| None`	Whether to fallback to AI if code run fails.
`script_id`	`str \| None`	ID of the cached script used for this workflow run, if any.
`run_request`	`WorkflowRunRequestOutput \| None`	The original request parameters used to start this workflow run

Example

import asyncio

from skyvern import Skyvern


async def main() -> None:
    skyvern = Skyvern(api_key="YOUR_API_KEY")
    result = await skyvern.download_files(
        navigation_goal="Download the latest invoice",
        url="https://example.com/billing",
    )
    print(result)


asyncio.run(main())

import { Skyvern } from "@skyvern/client";

const skyvern = new Skyvern({ apiKey: "YOUR_API_KEY" });
const result = await skyvern.downloadFiles({
    url: "https://example.com/billing",
    navigation_goal: "Download the latest invoice",
});
console.log(result);

get_version

Returns the current Skyvern server version (git SHA for official builds).

await skyvern.get_version() -> dict[str, str]

skyvern.getVersion(): Promise<Record<string, string>>

Returns dict[str, str] · TypeScript Promise<Record<string, string>> — Current server version Example

import asyncio

from skyvern import Skyvern

async def main() -> None:
    skyvern = Skyvern(api_key="YOUR_API_KEY")
    result = await skyvern.get_version()
    print(result)

asyncio.run(main())

import { Skyvern } from "@skyvern/client";

const skyvern = new Skyvern({ apiKey: "YOUR_API_KEY" });
const result = await skyvern.getVersion();
console.log(result);

SDK

Browser automation

API client

download_files

get_version

​login

​download_files

​get_version

login

download_files

get_version