---
canonical_url: "https://docs.composio.dev/toolkits/browser_use"
markdown_url: "https://docs.composio.dev/toolkits/browser_use.md"
product: "platform"
version: null
last_updated: null
---

# Browser Use

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

- **Category:** web scraping & browser
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 47
- **Triggers:** 0
- **Slug:** `BROWSER_USE`
- **Version:** 20261014_01
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | integer | Yes | Pending queued message to cancel. |
| `session_id` | string | Yes | Conversation session that owns the queued message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Run

**Slug:** `BROWSER_USE_CANCEL_RUN`

Idempotently cancel an in-flight browser-agent run; completed work cannot be resumed by this call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | In-flight run to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | object | No | Up to 10 caller-defined string key/value labels for filtering this browser later. |
| `profile_id` | string | No | Persistent browser profile to load. |
| `custom_proxy` | object | No | Custom proxy settings; when omitted, Browser Use managed proxies are used. |
| `screen_width` | integer | No | Initial browser screen width in pixels, from 320 to 6144. |
| `screen_height` | integer | No | Initial browser screen height in pixels, from 320 to 3456. |
| `allow_resizing` | boolean | No | Whether to allow viewport resizing after launch; enabling it can reduce stealthiness. |
| `solve_captchas` | boolean | No | Whether Browser Use detects and solves CAPTCHAs automatically. |
| `timeout_minutes` | integer | No | Browser lifetime in minutes, from 1 to 240; time is charged upfront. |
| `enable_recording` | boolean | No | 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") | No | Two-letter proxy country code, or null to disable the Browser Use proxy. |
| `pdf_renderer_enabled` | boolean | No | Whether Chrome renders PDFs in a tab; downloaded PDF files are saved either way. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Browser Profile

**Slug:** `BROWSER_USE_CREATE_PROFILE`

Create a persistent browser profile for reusable cookies and browser state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional profile name, up to 100 characters. |
| `user_id` | string | No | Optional caller-defined user identifier, up to 255 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace

**Slug:** `BROWSER_USE_CREATE_WORKSPACE`

Create an empty workspace for browser-run input files and outputs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional workspace name, up to 100 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Extension

**Slug:** `BROWSER_USE_DELETE_EXTENSION`

Permanently delete an uploaded extension. Running browsers are unaffected, but future browsers cannot install it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extension_id` | string | Yes | Uploaded extension to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Browser Profile

**Slug:** `BROWSER_USE_DELETE_PROFILE`

Permanently delete a persistent browser profile and its configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Persistent browser profile to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Conversation session to soft-delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace File

**Slug:** `BROWSER_USE_DELETE_WORKSPACE_FILE`

Permanently delete one exact relative file path from a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `path` | string | Yes | Exact non-empty relative file path to delete; prefixes are not accepted. |
| `workspace_id` | string | Yes | Workspace containing the file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Integration

**Slug:** `BROWSER_USE_DISCONNECT_INTEGRATION`

Disconnect a downstream provider from the Browser Use project, revoking its availability to future runs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | Yes | Connected provider identifier to disconnect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browser Session

**Slug:** `BROWSER_USE_GET_BROWSER_SESSION`

Get a managed browser's status, control URLs, costs, metadata, and recording state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Managed browser session to retrieve, not a conversation session ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Extension

**Slug:** `BROWSER_USE_GET_EXTENSION`

Get an uploaded browser extension by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extension_id` | string | Yes | Uploaded extension to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration Status

**Slug:** `BROWSER_USE_GET_INTEGRATION_STATUS`

Check whether one downstream integration provider is connected to the Browser Use project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | Yes | Provider identifier returned by List Integrations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browser Profile

**Slug:** `BROWSER_USE_GET_PROFILE`

Get one persistent browser profile's metadata and observed cookie domains.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Persistent browser profile to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Queued Message

**Slug:** `BROWSER_USE_GET_QUEUED_MESSAGE`

Get one queued session message, including its terminal handoff state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | integer | Yes | Queued message identifier returned by queue or list operations. |
| `session_id` | string | Yes | Conversation session that owns the queued message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Run to retrieve. |
| `include_attachments` | boolean | No | Also return the upload files attached to the run in attachment order; adds one API request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Run whose current status to read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session

**Slug:** `BROWSER_USE_GET_SESSION`

Get one conversation session's latest-run summary and busy or idle status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Conversation session to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Session whose recorded usage costs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Feedback

**Slug:** `BROWSER_USE_GET_SESSION_FEEDBACK`

Get all feedback votes recorded for a conversation session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Conversation session whose feedback votes should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Conversation session whose share-link state should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `BROWSER_USE_GET_WORKSPACE`

Get workspace metadata and optionally its current storage use and plan quota.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_size` | boolean | No | Also return current storage use and the plan quota; adds one API request. |
| `workspace_id` | string | Yes | Workspace to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace whose current storage usage and quota to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum downloads to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned as next_cursor by the previous page. Omit for the first page and pass it back unchanged. |
| `session_id` | string | Yes | Managed browser session whose downloads to list. |
| `include_urls` | boolean | No | Include presigned download URLs that expire after 15 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | One-based page number. Pass the integer next_cursor from the previous response, or use 1 for the first page. |
| `status` | string ("active" | "stopped") | No | Return only browser sessions with this status. |
| `metadata` | array | No | 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 | No | Maximum browser sessions to return in this page, from 1 to 100. |
| `agent_session_id` | string | No | Return only browsers created by this Browser Use agent session. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Extensions

**Slug:** `BROWSER_USE_LIST_EXTENSIONS`

List browser extensions uploaded to the project one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | One-based page number; pass next_cursor from the previous response. |
| `page_size` | integer | No | Maximum extensions to return in this page, from 1 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Integration Categories

**Slug:** `BROWSER_USE_LIST_INTEGRATION_CATEGORIES`

List the category names used to organize Browser Use integration providers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum integrations to return in this page; omit to use the provider default. |
| `cursor` | string | No | Continuation cursor returned as next_cursor by the previous page. Omit for the first page and pass it back unchanged. |
| `search` | string | No | Search integration names, descriptions, and provider identifiers. |
| `popular_only` | boolean | No | Return only integrations marked as popular. |
| `connected_only` | boolean | No | Return only integrations connected to this Browser Use project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Run Payment Methods

**Slug:** `BROWSER_USE_LIST_PAYMENT_METHODS`

Return AgentCard wallets and the project's active Stripe Link connection that browser runs can use for payments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Browser Profiles

**Slug:** `BROWSER_USE_LIST_PROFILES`

List or search persistent browser profiles one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search profile names or user identifiers; at most 200 characters. |
| `cursor` | integer | No | One-based page number. Pass the integer next_cursor from the previous response, or use 1 for the first page. |
| `page_size` | integer | No | Maximum profiles to return in this page, from 1 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Run whose ordered input-file attachments to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | 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 | No | Maximum events to return in this page. |
| `run_id` | string | Yes | Run whose execution events to read. |
| `include_output` | boolean | No | Whether to include event output payloads; disable to reduce response size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Runs

**Slug:** `BROWSER_USE_LIST_RUNS`

List browser-agent runs, optionally restricted to one conversation session, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum runs to return in this page. |
| `cursor` | string | No | Continuation cursor returned as next_cursor by the previous page. Omit for the first page and pass it back unchanged. |
| `session_id` | string | No | Return only runs from this conversation session. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Conversation session whose queued messages should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sessions

**Slug:** `BROWSER_USE_LIST_SESSIONS`

List conversation sessions with each session's latest run and busy or idle status, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum sessions to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned as next_cursor by the previous page. Omit for the first page and pass it back unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum files to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned as next_cursor by the previous page. Omit for the first page and pass it back unchanged. |
| `prefix` | string | No | Return only workspace-relative paths beginning with this prefix. |
| `include_urls` | boolean | No | Include temporary download URLs in file rows. |
| `workspace_id` | string | Yes | Workspace whose files to list. |
| `content_disposition` | string | No | Set generated download URLs to use attachment disposition; the only accepted value is 'attachment'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Queue Session Message

**Slug:** `BROWSER_USE_QUEUE_SESSION_MESSAGE`

Queue a follow-up for a conversation session, optionally interrupting its active run; dispatch may consume credits and trigger external browser work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Follow-up instruction to deliver to the conversation session. |
| `interrupt` | boolean | No | Whether to interrupt the active run before delivering this message instead of waiting for the next turn. |
| `session_id` | string | Yes | Conversation session that should receive the message. |
| `attached_file_ids` | array | No | Workspace file IDs to attach to the message; at most 20. |
| `deduplication_key` | string | No | Caller-chosen key that prevents duplicate queued messages on retries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Session Feedback

**Slug:** `BROWSER_USE_SET_SESSION_FEEDBACK`

Set, replace, or clear feedback for one session chat item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment` | string | No | Optional feedback comment, or null to clear the existing comment. |
| `item_id` | string | Yes | Chat item ID, formatted as e followed by a nonzero integer. |
| `session_id` | string | Yes | Conversation session containing the chat item. |
| `feedback_type` | string ("up" | "down") | No | Thumbs vote to set, or null to clear the existing vote. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_active` | boolean | Yes | True to create or reactivate the stable public link; false to deactivate it. |
| `session_id` | string | Yes | Conversation session whose public exposure to change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start run

**Slug:** `BROWSER_USE_START_RUN`

Start run

**Instant:** Supported on the latest version.

**Instant pricing:** Instant: the full maximum spend specified in the required max_cost_usd field is charged in USD per accepted task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | string | Yes | Browser task to perform. |
| `judge` | object | No | 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") | No | Instant supports gpt-5.6-luna and bu-ultrafast. BYOK can select any supported model. |
| `agentmail` | boolean | No | Whether to enable AgentMail for this run. |
| `session_id` | string | No | Existing conversation session to continue; omit to create a new session. |
| `op_vault_id` | string | No | 1Password vault ID whose credentials are available to the run. |
| `max_cost_usd` | string | No | Required for Instant: positive USD amount up to 100 USD, charged when the run is accepted and sent as the provider run cap. Optional for BYOK; the Instant maximum does not apply to BYOK. |
| `model_params` | object | No | Provider-native parameters for the selected model. Not supported by bu-ultrafast. |
| `workspace_id` | string | No | Workspace whose input files and outputs this run may use. |
| `secret_bindings` | array | No | Run-scoped credentials the browser agent may enter on allowed domains; at most 10. |
| `browser_settings` | object | No | Browser configuration for this run. |
| `attached_file_ids` | array | No | Workspace file IDs to attach, in order; at most 20. |
| `agentcard_wallet_id` | string | No | AgentCard wallet the run may use for payments. |
| `op_vault_allowed_domains` | array | No | Domains on which credentials from the selected 1Password vault may be used. |
| `stripe_link_connection_id` | string | No | Active Stripe Link connection the run may use for payments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Managed browser session to stop, not a conversation session ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Browser Profile

**Slug:** `BROWSER_USE_UPDATE_PROFILE`

Update a persistent browser profile's name, user identifier, or both.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New profile name. Omit or pass null to leave it unchanged. |
| `user_id` | string | No | New caller-defined user identifier. Omit or pass null to leave it unchanged. |
| `profile_id` | string | Yes | Persistent browser profile to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Session

**Slug:** `BROWSER_USE_UPDATE_SESSION`

Rename a conversation session or explicitly clear its title.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | New session title, or null to clear it and fall back to the opening task. |
| `session_id` | string | Yes | Conversation session to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace

**Slug:** `BROWSER_USE_UPDATE_WORKSPACE`

Rename a workspace or explicitly clear its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New workspace name, or null to clear it; omit to leave it unchanged. |
| `workspace_id` | string | Yes | Workspace to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |