> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Browser Use

> Browser Use Cloud provides hosted browser agents, managed browser sessions, workspaces, profiles, and integrations for automating web tasks.

![Browser Use logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/browser_use.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=ba686baf3378c1b759a213f61f1bbb80)

* **Category:** web scraping & browser
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 48
* **Triggers:** 0
* **Slug:** `BROWSER_USE`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Archive Workspace
>
> **Slug:** `BROWSER_USE_ARCHIVE_WORKSPACE`
>
> Archive a workspace so it is no longer readable through the workspace API; the operation is idempotent for missing, already archived, and foreign workspace IDs. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **workspace\_id** `string` *required*
>
> Workspace to archive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Queued Message
>
> **Slug:** `BROWSER_USE_CANCEL_QUEUED_MESSAGE`
>
> Cancel a queued session message while it is still pending; messages already claimed for dispatch cannot be cancelled. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **message\_id** `integer` *required*
>
> Pending queued message to cancel.
>
> **session\_id** `string` *required*
>
> Conversation session that owns the queued message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Run
>
> **Slug:** `BROWSER_USE_CANCEL_RUN`
>
> Idempotently cancel an in-flight browser-agent run; completed work cannot be resumed by this call. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **run\_id** `string` *required*
>
> In-flight run to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Browser Session
>
> **Slug:** `BROWSER_USE_CREATE_BROWSER_SESSION`
>
> Launch a paid managed browser for direct CDP control; time is prepaid and unused time is refunded when the browser is stopped. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **metadata** `object`
>
> Up to 10 caller-defined string key/value labels for filtering this browser later.
>
> **profile\_id** `string`
>
> Persistent browser profile to load.
>
> **custom\_proxy** `object`
>
> Custom proxy settings; when omitted, Browser Use managed proxies are used.
>
> **screen\_width** `integer`
>
> Initial browser screen width in pixels, from 320 to 6144.
>
> **screen\_height** `integer`
>
> Initial browser screen height in pixels, from 320 to 3456.
>
> **allow\_resizing** `boolean`
>
> Whether to allow viewport resizing after launch; enabling it can reduce stealthiness.
>
> **solve\_captchas** `boolean`
>
> Whether Browser Use detects and solves CAPTCHAs automatically.
>
> **timeout\_minutes** `integer`
>
> Browser lifetime in minutes, from 1 to 240; time is charged upfront.
>
> **enable\_recording** `boolean`
>
> Whether to record the managed browser session.
>
> **proxy\_country\_code** `string ("ad" | "ae" | "af" | "ag" | "ai" | "al" | "am" | "an" | "ao" | "aq" | "ar" | "as" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bl" | "bm" | "bn" | "bo" | "bq" | "br" | "bs" | "bt" | "bv" | "bw" | "by" | "bz" | "ca" | "cc" | "cd" | "cf" | "cg" | "ch" | "ci" | "ck" | "cl" | "cm" | "co" | "cr" | "cs" | "cu" | "cv" | "cw" | "cx" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "do" | "dz" | "ec" | "ee" | "eg" | "eh" | "er" | "es" | "et" | "fi" | "fj" | "fk" | "fm" | "fo" | "fr" | "ga" | "gd" | "ge" | "gf" | "gg" | "gh" | "gi" | "gl" | "gm" | "gn" | "gp" | "gq" | "gr" | "gs" | "gt" | "gu" | "gw" | "gy" | "hk" | "hm" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "im" | "in" | "iq" | "ir" | "is" | "it" | "je" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "ki" | "km" | "kn" | "kp" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "li" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "mc" | "md" | "me" | "mf" | "mg" | "mh" | "mk" | "ml" | "mm" | "mn" | "mo" | "mp" | "mq" | "mr" | "ms" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "nf" | "ng" | "ni" | "nl" | "no" | "np" | "nr" | "nu" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "pm" | "pn" | "pr" | "ps" | "pt" | "pw" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sb" | "sc" | "sd" | "se" | "sg" | "sh" | "si" | "sj" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "ss" | "st" | "sv" | "sx" | "sy" | "sz" | "tc" | "td" | "tf" | "tg" | "th" | "tj" | "tk" | "tl" | "tm" | "tn" | "to" | "tr" | "tt" | "tv" | "tw" | "tz" | "ua" | "ug" | "uk" | "us" | "uy" | "uz" | "va" | "vc" | "ve" | "vg" | "vi" | "vn" | "vu" | "wf" | "ws" | "xk" | "ye" | "yt" | "za" | "zm" | "zw")`
>
> Two-letter proxy country code, or null to disable the Browser Use proxy.
>
> **pdf\_renderer\_enabled** `boolean`
>
> Whether Chrome renders PDFs in a tab; downloaded PDF files are saved either way.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Browser Profile
>
> **Slug:** `BROWSER_USE_CREATE_PROFILE`
>
> Create a persistent browser profile for reusable cookies and browser state. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional profile name, up to 100 characters.
>
> **user\_id** `string`
>
> Optional caller-defined user identifier, up to 255 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Workspace
>
> **Slug:** `BROWSER_USE_CREATE_WORKSPACE`
>
> Create an empty workspace for browser-run input files and outputs.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional workspace name, up to 100 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Extension
>
> **Slug:** `BROWSER_USE_DELETE_EXTENSION`
>
> Permanently delete an uploaded extension; running browsers are unaffected, but future browsers cannot install it. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **extension\_id** `string` *required*
>
> Uploaded extension to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Browser Profile
>
> **Slug:** `BROWSER_USE_DELETE_PROFILE`
>
> Permanently delete a persistent browser profile and its configuration. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **profile\_id** `string` *required*
>
> Persistent browser profile to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Session
>
> **Slug:** `BROWSER_USE_DELETE_SESSION`
>
> Soft-delete a conversation session and cancel its active run and pending messages; the session can no longer be opened or continued, while runs, events, and usage records remain available for billing and analytics. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Conversation session to soft-delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Workspace File
>
> **Slug:** `BROWSER_USE_DELETE_WORKSPACE_FILE`
>
> Permanently delete one exact relative file path from a workspace.
>
> #### Input Parameters
>
> **path** `string` *required*
>
> Exact non-empty relative file path to delete; prefixes are not accepted.
>
> **workspace\_id** `string` *required*
>
> Workspace containing the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disconnect Integration
>
> **Slug:** `BROWSER_USE_DISCONNECT_INTEGRATION`
>
> Disconnect a downstream provider from the Browser Use project, revoking its availability to future runs. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **provider** `string` *required*
>
> Connected provider identifier to disconnect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Billing Account
>
> **Slug:** `BROWSER_USE_GET_BILLING_ACCOUNT`
>
> Return the connected Browser Use project's credit balances, plan, concurrency limits, and account identifiers. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Browser Session
>
> **Slug:** `BROWSER_USE_GET_BROWSER_SESSION`
>
> Get a managed browser's status, control URLs, costs, metadata, and recording state. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Managed browser session to retrieve, not a conversation session ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Extension
>
> **Slug:** `BROWSER_USE_GET_EXTENSION`
>
> Get an uploaded browser extension by ID. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **extension\_id** `string` *required*
>
> Uploaded extension to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Integration Status
>
> **Slug:** `BROWSER_USE_GET_INTEGRATION_STATUS`
>
> Check whether one downstream integration provider is connected to the Browser Use project. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **provider** `string` *required*
>
> Provider identifier returned by List Integrations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Browser Profile
>
> **Slug:** `BROWSER_USE_GET_PROFILE`
>
> Get one persistent browser profile's metadata and observed cookie domains. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **profile\_id** `string` *required*
>
> Persistent browser profile to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Queued Message
>
> **Slug:** `BROWSER_USE_GET_QUEUED_MESSAGE`
>
> Get one queued session message, including its handoff state. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **message\_id** `integer` *required*
>
> Queued message identifier returned by queue or list operations.
>
> **session\_id** `string` *required*
>
> Conversation session that owns the queued message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run
>
> **Slug:** `BROWSER_USE_GET_RUN`
>
> Get a run's full result, usage, and optionally its ordered input-file attachments.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **run\_id** `string` *required*
>
> Run to retrieve.
>
> **include\_attachments** `boolean`
>
> Also return the upload files attached to the run in attachment order; adds one API request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Status
>
> **Slug:** `BROWSER_USE_GET_RUN_STATUS`
>
> Read a run's lightweight indexed status for caller-controlled polling. Poll until the status is completed, failed, or cancelled, then fetch the full run once for its result and usage.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **run\_id** `string` *required*
>
> Run whose current status to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Session
>
> **Slug:** `BROWSER_USE_GET_SESSION`
>
> Get one conversation session's latest-run summary and lifecycle status. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Conversation session to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Session Cost
>
> **Slug:** `BROWSER_USE_GET_SESSION_COST`
>
> Get a session's recorded LLM, search, browser, and proxy usage costs. Costs can continue settling for about 90 seconds after a run finishes and do not reflect promotional credits or invoice adjustments.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Session whose recorded usage costs to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Session Feedback
>
> **Slug:** `BROWSER_USE_GET_SESSION_FEEDBACK`
>
> Get all feedback votes recorded for a conversation session.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Conversation session whose feedback votes should be retrieved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Session Share
>
> **Slug:** `BROWSER_USE_GET_SESSION_SHARE`
>
> Get a session's current or inactive public share-link state without changing its exposure.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Conversation session whose share-link state should be retrieved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stripe Link Status
>
> **Slug:** `BROWSER_USE_GET_STRIPE_LINK_STATUS`
>
> Get the project's active Stripe Link connection, if any; its connection ID can be passed to START\_RUN. Connecting must be completed in the cloud UI.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace
>
> **Slug:** `BROWSER_USE_GET_WORKSPACE`
>
> Get workspace metadata and optionally its current storage use and plan quota.
>
> #### Input Parameters
>
> **include\_size** `boolean`
>
> Also return current storage use and the plan quota; adds one API request.
>
> **workspace\_id** `string` *required*
>
> Workspace to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace Size
>
> **Slug:** `BROWSER_USE_GET_WORKSPACE_SIZE`
>
> Get a workspace's current storage use and plan-specific quota without retrieving workspace metadata.
>
> #### Input Parameters
>
> **workspace\_id** `string` *required*
>
> Workspace whose current storage usage and quota to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List AgentCard Wallets
>
> **Slug:** `BROWSER_USE_LIST_AGENTCARD_WALLETS`
>
> List active project AgentCard wallets whose IDs can be passed to START\_RUN; funding remains admin-only. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Browser Downloads
>
> **Slug:** `BROWSER_USE_LIST_BROWSER_DOWNLOADS`
>
> List one page of files downloaded by a managed browser, optionally including presigned URLs that expire after 15 minutes. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum downloads to return in this page, from 1 to 100.
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous page. Omit for the first page and pass it back unchanged.
>
> **session\_id** `string` *required*
>
> Managed browser session whose downloads to list.
>
> **include\_urls** `boolean`
>
> Include presigned download URLs that expire after 15 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Browser Sessions
>
> **Slug:** `BROWSER_USE_LIST_BROWSER_SESSIONS`
>
> List managed browser sessions with status, metadata, and agent-session filters, one page at a time. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **cursor** `integer`
>
> One-based page number. Pass the integer next\_cursor from the previous response, or use 1 for the first page.
>
> **status** `string ("active" | "stopped")`
>
> Return only browser sessions with this status.
>
> **metadata** `array`
>
> Metadata terms that must all match. Use key to match any value or key=value for an exact match; terms are sent as repeated query parameters.
>
> **page\_size** `integer`
>
> Maximum browser sessions to return in this page, from 1 to 100.
>
> **agent\_session\_id** `string`
>
> Return only browsers created by this Browser Use agent session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Extensions
>
> **Slug:** `BROWSER_USE_LIST_EXTENSIONS`
>
> List browser extensions uploaded to the project one page at a time. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **cursor** `integer`
>
> One-based page number; pass next\_cursor from the previous response.
>
> **page\_size** `integer`
>
> Maximum extensions to return in this page, from 1 to 100.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Integration Categories
>
> **Slug:** `BROWSER_USE_LIST_INTEGRATION_CATEGORIES`
>
> List the category names used to organize Browser Use integration providers. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Integrations
>
> **Slug:** `BROWSER_USE_LIST_INTEGRATIONS`
>
> Search Browser Use integration providers and filter by popularity or project connection status, one page at a time. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum integrations to return in this page; omit to use the provider default.
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous page. Omit for the first page and pass it back unchanged.
>
> **search** `string`
>
> Search integration names, descriptions, and provider identifiers.
>
> **popular\_only** `boolean`
>
> Return only integrations marked as popular.
>
> **connected\_only** `boolean`
>
> Return only integrations connected to this Browser Use project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Run Payment Methods
>
> **Slug:** `BROWSER_USE_LIST_PAYMENT_METHODS`
>
> List AgentCard wallets and the project's Stripe Link connection state for run payments. A source may be unavailable, with partial failures reported; requires a connected Browser Use account and is unavailable on Instant accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Browser Profiles
>
> **Slug:** `BROWSER_USE_LIST_PROFILES`
>
> List or search persistent browser profiles one page at a time. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **query** `string`
>
> Search profile names or user identifiers; at most 200 characters.
>
> **cursor** `integer`
>
> One-based page number. Pass the integer next\_cursor from the previous response, or use 1 for the first page.
>
> **page\_size** `integer`
>
> Maximum profiles to return in this page, from 1 to 100.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Run Attachments
>
> **Slug:** `BROWSER_USE_LIST_RUN_ATTACHMENTS`
>
> List a run's ordered input-file attachments without retrieving the full run result and usage summary. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **run\_id** `string` *required*
>
> Run whose ordered input-file attachments to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Run Events
>
> **Slug:** `BROWSER_USE_LIST_RUN_EVENTS`
>
> Read one page of a run's execution events incrementally, with optional event output payloads.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **after** `string`
>
> Event cursor returned as next\_cursor by a previous call. Omit for the first page and pass it back unchanged to continue after that event.
>
> **limit** `integer`
>
> Maximum events to return in this page.
>
> **run\_id** `string` *required*
>
> Run whose execution events to read.
>
> **include\_output** `boolean`
>
> Whether to include event output payloads; disable to reduce response size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Runs
>
> **Slug:** `BROWSER_USE_LIST_RUNS`
>
> List browser-agent runs, optionally restricted to one conversation session, one page at a time. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum runs to return in this page.
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous page. Omit for the first page and pass it back unchanged.
>
> **session\_id** `string`
>
> Return only runs from this conversation session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Session Queue
>
> **Slug:** `BROWSER_USE_LIST_SESSION_QUEUE`
>
> List pending and recently delivered messages for a conversation session, including transcript cutoffs created by steering interrupts.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Conversation session whose queued messages should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sessions
>
> **Slug:** `BROWSER_USE_LIST_SESSIONS`
>
> List conversation sessions one page at a time, including each session's latest run and its lifecycle status.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum sessions to return in this page, from 1 to 100.
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous page. Omit for the first page and pass it back unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workspace Files
>
> **Slug:** `BROWSER_USE_LIST_WORKSPACE_FILES`
>
> List one page of files in a workspace by path prefix, optionally including temporary download URLs.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum files to return in this page, from 1 to 100.
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous page. Omit for the first page and pass it back unchanged.
>
> **prefix** `string`
>
> Return only workspace-relative paths beginning with this prefix.
>
> **include\_urls** `boolean`
>
> Include temporary download URLs in file rows.
>
> **workspace\_id** `string` *required*
>
> Workspace whose files to list.
>
> **content\_disposition** `string`
>
> Set generated download URLs to use attachment disposition; the only accepted value is 'attachment'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Queue Session Message
>
> **Slug:** `BROWSER_USE_QUEUE_SESSION_MESSAGE`
>
> Queue a follow-up for a conversation session, optionally interrupting its active run; dispatch is charged and may trigger external browser work. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Follow-up instruction to deliver to the conversation session.
>
> **interrupt** `boolean`
>
> Whether to interrupt the active run before delivering this message instead of waiting for the next turn.
>
> **session\_id** `string` *required*
>
> Conversation session that should receive the message.
>
> **attached\_file\_ids** `array`
>
> Workspace file IDs to attach to the message; at most 20.
>
> **deduplication\_key** `string`
>
> Caller-chosen key that prevents duplicate queued messages on retries.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Session Feedback
>
> **Slug:** `BROWSER_USE_SET_SESSION_FEEDBACK`
>
> Set, replace, or clear feedback for one session chat item.
>
> #### Input Parameters
>
> **comment** `string`
>
> Optional feedback comment, or null to clear the existing comment.
>
> **item\_id** `string` *required*
>
> Chat item ID, formatted as e followed by a nonzero integer.
>
> **session\_id** `string` *required*
>
> Conversation session containing the chat item.
>
> **feedback\_type** `string ("up" | "down")`
>
> Thumbs vote to set, or null to clear the existing vote.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Session Sharing
>
> **Slug:** `BROWSER_USE_SET_SESSION_SHARING`
>
> Enable or disable a session's stable public share link, creating or reactivating it when enabled.
>
> #### Input Parameters
>
> **is\_active** `boolean` *required*
>
> True to create or reactivate the stable public link; false to deactivate it.
>
> **session\_id** `string` *required*
>
> Conversation session whose public exposure to change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start run
>
> **Slug:** `BROWSER_USE_START_RUN`
>
> Start an asynchronous hosted browser-agent task that may make irreversible changes on external sites, with an optional max\_cost\_usd run cost cap. Instant connections require the cap, charge its full amount when the run is accepted, and allow only GPT-5.6 Luna and BU Ultra Fast.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Limited-time offer: Browser Use runs are free. max\_cost\_usd is required.
>
> #### Input Parameters
>
> **task** `string` *required*
>
> Browser task to perform.
>
> **judge** `object`
>
> Optional evaluation settings; providing an object enables billed run judging.
>
> **model** `string ("bu-ultrafast" | "glm-5.2" | "grok-4.5" | "grok-4.6" | "glm-5.3-flash" | "deepseek-v4-flash-vision" | "kimi-k3" | "minimax-m3" | "claude-opus-4.7" | "claude-opus-4.8" | "claude-opus-5" | "claude-fable-5" | "claude-sonnet-5" | "gpt-5.5" | "gpt-5.6" | "gpt-6-astra" | "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna" | "gemini-3.6-flash" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash")`
>
> Model for the agent. Some connections allow only gpt-5.6-luna and bu-ultrafast.
>
> **agentmail** `boolean`
>
> Whether to enable AgentMail for this run.
>
> **session\_id** `string`
>
> Existing conversation session to continue; omit to create a new session.
>
> **op\_vault\_id** `string`
>
> 1Password vault ID whose credentials are available to the run.
>
> **max\_cost\_usd** `string`
>
> Maximum spend for the run in USD, sent as the run cost cap. Must be positive. Required on some connections, where it is capped at 5 USD. It limits the run's spend and is not charged during the current free offer.
>
> **model\_params** `object`
>
> Provider-native parameters for the selected model. Not supported by bu-ultrafast.
>
> **workspace\_id** `string`
>
> Workspace whose input files and outputs this run may use.
>
> **secret\_bindings** `array`
>
> Run-scoped credentials the browser agent may enter on allowed domains; at most 10.
>
> **browser\_settings** `object`
>
> Browser configuration for this run.
>
> **attached\_file\_ids** `array`
>
> Workspace file IDs to attach, in order; at most 20.
>
> **agentcard\_wallet\_id** `string`
>
> AgentCard wallet the run may use for payments.
>
> **op\_vault\_allowed\_domains** `array`
>
> Domains on which credentials from the selected 1Password vault may be used.
>
> **stripe\_link\_connection\_id** `string`
>
> Active Stripe Link connection the run may use for payments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop Browser Session
>
> **Slug:** `BROWSER_USE_STOP_BROWSER_SESSION`
>
> Stop a managed browser session and refund unused prepaid time subject to the one-minute minimum charge.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Managed browser session to stop, not a conversation session ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Browser Profile
>
> **Slug:** `BROWSER_USE_UPDATE_PROFILE`
>
> Update a persistent browser profile's name, user identifier, or both. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **name** `string`
>
> New profile name. Omit or pass null to leave it unchanged.
>
> **user\_id** `string`
>
> New caller-defined user identifier. Omit or pass null to leave it unchanged.
>
> **profile\_id** `string` *required*
>
> Persistent browser profile to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Session
>
> **Slug:** `BROWSER_USE_UPDATE_SESSION`
>
> Rename a conversation session or explicitly clear its title. Requires a connected Browser Use account; unavailable on Instant accounts.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> New session title, or null to clear it and fall back to the opening task.
>
> **session\_id** `string` *required*
>
> Conversation session to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Workspace
>
> **Slug:** `BROWSER_USE_UPDATE_WORKSPACE`
>
> Rename a workspace or explicitly clear its name.
>
> #### Input Parameters
>
> **name** `string`
>
> New workspace name, or null to clear it; omit to leave it unchanged.
>
> **workspace\_id** `string` *required*
>
> Workspace to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
