Sign in
Agents

Login Task

Log in to a website using either credential stored in Skyvern, Bitwarden, 1Password, or Azure Vault

post/v1/run/tasks/login

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

x-user-agentstring nullable

Request body

urlstring nullable

Website URL

webhook_urlstring nullable

Webhook URL to send status updates

proxy_location'RESIDENTIAL' | 'US-CA' | 'US-NY' | 'US-TX' | 'US-FL' | 'US-WA' | 'RESIDENTIAL_ES' | 'RESIDENTIAL_IE' | 'RESIDENTIAL_GB' | 'RESIDENTIAL_IN' | 'RESIDENTIAL_JP' | 'RESIDENTIAL_FR' | 'RESIDENTIAL_DE' | 'RESIDENTIAL_NZ' | 'RESIDENTIAL_ZA' | 'RESIDENTIAL_AR' | 'RESIDENTIAL_AU' | 'RESIDENTIAL_BR' | 'RESIDENTIAL_TR' | 'RESIDENTIAL_CA' | 'RESIDENTIAL_MX' | 'RESIDENTIAL_IT' | 'RESIDENTIAL_NL' | 'RESIDENTIAL_PH' | 'RESIDENTIAL_KR' | 'RESIDENTIAL_SA' | 'RESIDENTIAL_ISP' | 'NONE'
totp_identifierstring nullable

Identifier for TOTP (Time-based One-Time Password) if required

totp_urlstring nullable

TOTP URL to fetch one-time passwords

browser_session_idstring nullable

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

browser_profile_idstring nullable

ID of a browser profile to reuse for this run

browser_addressstring nullable

The CDP address for the task.

extra_http_headersobject nullable

Additional HTTP headers to include in requests

cdp_connect_headersobject nullable

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

max_screenshot_scrolling_timesinteger nullable

Maximum number of times to scroll for screenshots

credential_type'skyvern' | 'bitwarden' | '1password' | 'azure_vault' required
promptstring nullable

Login instructions. Skyvern has default prompt/instruction for login if this field is not provided.

credential_idstring nullable

ID of the Skyvern credential to use for login.

bitwarden_collection_idstring nullable

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

bitwarden_item_idstring nullable

Bitwarden item ID

onepassword_vault_idstring nullable

1Password vault ID

onepassword_item_idstring nullable

1Password item ID

azure_vault_namestring nullable

Azure Vault Name

azure_vault_username_keystring nullable

Azure Vault username key

azure_vault_password_keystring nullable

Azure Vault password key

azure_vault_totp_secret_keystring nullable

Azure Vault TOTP secret key

Example request

{
  "browser_session_id": "pbs_123456",
  "browser_address": "http://127.0.0.1:9222",
  "credential_id": "cred_123"
}

Response

Successful Response

run_idstring required

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' required
recording_urlstring nullable

URL to the recording of the run

recording_archivedboolean

True when the recording exists but has been archived to cold storage and is not currently accessible.

screenshot_urlsstring[] nullable

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

failure_reasonstring nullable

Reason for failure if the run failed or terminated

created_atstring date-time required

Timestamp when this run was created

modified_atstring date-time required

Timestamp when this run was last modified

queued_atstring date-time nullable

Timestamp when this run was queued

started_atstring date-time nullable

Timestamp when this run started execution

finished_atstring date-time nullable

Timestamp when this run finished

app_urlstring nullable

URL to the application UI where the run can be viewed

browser_session_idstring nullable

ID of the Skyvern persistent browser session used for this run

browser_profile_idstring nullable

ID of the browser profile used for this run

max_screenshot_scrollsinteger nullable

The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot

errorsobject[] nullable

The errors for the run

step_countinteger nullable

Total number of steps executed in this run

run_type'workflow_run' required

Type of run - always workflow_run for workflow runs

run_withstring

Whether the workflow run was executed with agent or code

ai_fallbackboolean nullable

Whether to fallback to AI if code run fails.

script_idstring nullable

ID of the cached script used for this workflow run, if any.

Example response

{
  "run_id": "tsk_123",
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:05:00Z",
  "app_url": "https://app.skyvern.com/tasks/tsk_123",
  "browser_session_id": "pbs_123",
  "browser_profile_id": "bp_123",
  "run_with": "agent",
  "run_request": {
    "workflow_id": "wpid_123",
    "proxy_location": {
      "country": "US",
      "subdivision": "CA",
      "city": "New York"
    },
    "totp_url": "https://my-totp-service.com/totp",
    "totp_identifier": "john.doe@example.com",
    "browser_address": "http://127.0.0.1:9222",
    "run_with": "agent"
  }
}

Changes

Changed in 12 of the 63 revisions of this API.3624

  • 645819945b7b1See the full diff
    • ●

      added the new paused enum value to the response property for the response status

      response-property-enum-value-added

  • cd89b4c6f0041See the full diff
    • ▲

      the /// response property's max was increased from 240.00 to 480.00 for the response status

      response-property-max-increased

  • e37d309fc58f2See the full diff
    • ○

      api tag Agents added

      api-tag-added

    • ○

      api tag Agent removed

      api-tag-removed

  • 172f5de044f25See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed from the response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • becdfa4d5ab31See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 9a8565aaedbf14See the full diff
    • ●

      added the new RESIDENTIAL_SA enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional header request parameter x-user-agent

      new-optional-request-parameter

    • ○

      added the new RESIDENTIAL_SA enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f97d3f2efafe131See the full diff
    • ▲

      removed the enum value RESIDENTIAL_SA of the request property /

      request-property-enum-value-removed

    • ●

      deleted the header request parameter x-user-agent

      request-parameter-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

      removed the RESIDENTIAL_SA enum value from the /// response property for the response status

      response-property-enum-value-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9a8565aaedbf14See the full diff
    • ●

      added the new RESIDENTIAL_SA enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional header request parameter x-user-agent

      new-optional-request-parameter

    • ○

      added the new RESIDENTIAL_SA enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0438e38c54cb2See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 8a4e8b880de82See the full diff
    • ○

      the response's property default value agent was added for the status

      response-property-default-value-added

    • ○

      response property run_with list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed