browser-use-sdk 3.4.3 → 3.6.0

package/dist/v3.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import { H as HttpClient } from './errors-BtB79l7x.js';
-export { B as BrowserUseError } from './errors-BtB79l7x.js';
+import { H as HttpClient, X as X402Client } from './errors-Bp9CqFUs.js';
+export { B as BrowserUseError } from './errors-Bp9CqFUs.js';
 
 interface components {
     schemas: {
@@ -50,6 +50,12 @@ interface components {
              * @description The plan information
              */
             planInfo: components["schemas"]["PlanInfo"];
+            /**
+             * Is Free Tier
+             * @description Whether the account is on the free tier
+             * @default false
+             */
+            isFreeTier: boolean;
             /**
              * Project ID
              * Format: uuid
@@ -57,6 +63,200 @@ interface components {
              */
             projectId: string;
         };
+        /** BoxCreateRequest */
+        BoxCreateRequest: {
+            /** Profile Id */
+            profile_id?: string | null;
+            /** Size */
+            size?: ("small" | "medium" | "large") | null;
+        };
+        /** BoxCreateResponse */
+        BoxCreateResponse: {
+            box: components["schemas"]["BoxView"];
+        };
+        /** BoxPatchRequest */
+        BoxPatchRequest: {
+            /** Dsp Enabled */
+            dsp_enabled?: boolean | null;
+        };
+        /**
+         * BoxResizeRequest
+         * @description Resize an existing box to a larger tier.
+         *
+         *     Upgrade-only: the backend rejects requests where `size` isn't strictly
+         *     larger than the box's current size. Downsize → 400 with a hint to
+         *     destroy + redeploy. Same size → 409 (idempotent failure — no work to do).
+         */
+        BoxResizeRequest: {
+            /**
+             * Size
+             * @enum {string}
+             */
+            size: "small" | "medium" | "large";
+        };
+        /**
+         * BoxRestartMode
+         * @description How aggressive a /me/restart should be.
+         *
+         *     `service` — fastest, fixes ~95% of cases (agent process crash, OOM,
+         *       wedged TG long-poll). SSM `systemctl restart bux-tg`. ~5s.
+         *     `reboot`  — fallback for kernel-hung / SSM-unreachable boxes. AWS
+         *       rebootInstances. ~30-60s. IP + EBS preserved.
+         * @enum {string}
+         */
+        BoxRestartMode: "service" | "reboot";
+        /** BoxRestartRequest */
+        BoxRestartRequest: {
+            /** @default service */
+            mode: components["schemas"]["BoxRestartMode"];
+        };
+        /**
+         * BoxSizeListResponse
+         * @description Catalog of available size tiers, returned to the deploy picker.
+         *
+         *     Keeping the list server-side (instead of hardcoding prices in the
+         *     frontend) means the day we re-tier or run a promo, we don't have
+         *     to ship a frontend deploy. Just edit `sizing.py`.
+         */
+        BoxSizeListResponse: {
+            /** Sizes */
+            sizes: components["schemas"]["BoxSizeSpecView"][];
+            /**
+             * Default
+             * @enum {string}
+             */
+            default: "small" | "medium" | "large";
+        };
+        /**
+         * BoxSizeSpecView
+         * @description User-visible spec sheet for one size tier. Returned alongside
+         *     BoxView so the UI can render the tooltip ("2 vCPU · 4 GB · 20 GB")
+         *     without a second round trip + so the picker on /bux can show all
+         *     three rows without us hardcoding prices in the frontend.
+         */
+        BoxSizeSpecView: {
+            /**
+             * Name
+             * @enum {string}
+             */
+            name: "small" | "medium" | "large";
+            /** Vcpu */
+            vcpu: number;
+            /** Ram Gb */
+            ram_gb: number;
+            /** Disk Gb */
+            disk_gb: number;
+            /** Daily Usd */
+            daily_usd: number;
+            /** Min Balance Usd */
+            min_balance_usd: number;
+        };
+        /**
+         * BoxStatus
+         * @enum {string}
+         */
+        BoxStatus: "provisioning" | "awaiting_oauth" | "ready" | "resizing" | "error" | "halted" | "destroyed";
+        /** BoxView */
+        BoxView: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /**
+             * Project Id
+             * Format: uuid
+             */
+            project_id: string;
+            /** Profile Id */
+            profile_id: string | null;
+            /**
+             * Size
+             * @enum {string}
+             */
+            size: "small" | "medium" | "large";
+            size_spec: components["schemas"]["BoxSizeSpecView"];
+            /** Ec2 Instance Id */
+            ec2_instance_id: string | null;
+            /** Public Ip */
+            public_ip: string | null;
+            status: components["schemas"]["BoxStatus"];
+            /** Status Detail */
+            status_detail: string | null;
+            /** Claude Authed */
+            claude_authed: boolean;
+            /** Tg Installed */
+            tg_installed: boolean;
+            /** Tg Bot Username */
+            tg_bot_username: string | null;
+            /** Dsp Enabled */
+            dsp_enabled: boolean;
+            /** Live Browser Url */
+            live_browser_url: string | null;
+            /** Last Heartbeat At */
+            last_heartbeat_at: string | null;
+            /** Trial Ends At */
+            trial_ends_at?: string | null;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+        };
+        /**
+         * BrowserDownloadFile
+         * @description A single file the browser downloaded during the session.
+         */
+        BrowserDownloadFile: {
+            /**
+             * Path
+             * @description File name (basename relative to the session downloads prefix)
+             */
+            path: string;
+            /**
+             * Size
+             * @description File size in bytes
+             */
+            size: number;
+            /**
+             * Lastmodified
+             * Format: date-time
+             * @description When the file was last modified in S3
+             */
+            lastModified: string;
+            /**
+             * Url
+             * @description Presigned download URL (15 min expiry). Only included when `includeUrls=true`.
+             */
+            url?: string | null;
+        };
+        /**
+         * BrowserDownloadListResponse
+         * @description Paginated list of browser downloads with optional presigned URLs.
+         */
+        BrowserDownloadListResponse: {
+            /**
+             * Files
+             * @description List of files downloaded by the browser
+             */
+            files: components["schemas"]["BrowserDownloadFile"][];
+            /**
+             * Nextcursor
+             * @description Cursor for the next page. Pass as the `cursor` query parameter to fetch the next page.
+             */
+            nextCursor?: string | null;
+            /**
+             * Hasmore
+             * @description Whether there are more files beyond this page.
+             * @default false
+             */
+            hasMore: boolean;
+        };
         /**
          * BrowserSessionItemView
          * @description View model for representing a browser session in list views.
@@ -265,11 +465,17 @@ interface components {
          *
          *     - `bu-mini` / `gemini-3-flash`: Gemini 3 Flash — fast and cost-effective. Best for simple, well-defined tasks like form filling or data extraction.
          *     - `bu-max` / `claude-sonnet-4.6`: Claude Sonnet 4.6 — balanced performance. Best for multi-step workflows that require reasoning and decision-making.
-         *     - `bu-ultra` / `claude-opus-4.6`: Claude Opus 4.6 — most capable. Best for complex tasks that require advanced reasoning, long-horizon planning, or handling ambiguous instructions.
+         *     - `bu-ultra` / `claude-opus-4.6`: Claude Opus 4.6 — capable general-purpose Opus tier.
+         *     - `claude-opus-4.7`: Claude Opus 4.7 — most capable. Best for complex tasks that require advanced reasoning, long-horizon planning, or handling ambiguous instructions.
          *     - `gpt-5.4-mini`: GPT-5.4 mini — OpenAI's fast and efficient model. Best for tasks that benefit from OpenAI's capabilities.
          * @enum {string}
          */
-        BuModel: "bu-mini" | "bu-max" | "bu-ultra" | "gemini-3-flash" | "claude-sonnet-4.6" | "claude-opus-4.6" | "gpt-5.4-mini";
+        BuModel: "bu-mini" | "bu-max" | "bu-ultra" | "gemini-3-flash" | "claude-sonnet-4.6" | "claude-opus-4.6" | "claude-opus-4.7" | "gpt-5.4-mini";
+        /** ClaudeLoginCodeRequest */
+        ClaudeLoginCodeRequest: {
+            /** Code */
+            code: string;
+        };
         /**
          * CreateBrowserSessionRequest
          * @description Request model for creating a browser session.
@@ -345,6 +551,12 @@ interface components {
              * @description Password for proxy authentication.
              */
             password?: string | null;
+            /**
+             * Ignore Certificate Errors
+             * @description Ignore TLS certificate errors. Enable this if your proxy uses a self-signed or untrusted certificate (e.g. Burp Suite, corporate proxies).
+             * @default false
+             */
+            ignoreCertErrors: boolean;
         };
         /**
          * FileInfo
@@ -696,106 +908,10 @@ interface components {
          * @enum {string}
          */
         ProxyCountryCode: "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" | "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";
-        /**
-         * RunTaskRequest
-         * @description Create a new session, dispatch a task, or both.
-         *
-         *     - **No `sessionId` + no `task`**: creates an idle session (useful for uploading files before running a task).
-         *     - **No `sessionId` + `task`**: creates a new session and immediately runs the task.
-         *     - **`sessionId` + `task`**: dispatches the task to an existing idle session.
-         *     - **`sessionId` + no `task`**: returns 422 — a task is required when targeting an existing session.
-         */
+        /** RunTaskRequest */
         RunTaskRequest: {
-            /**
-             * Task
-             * @description The natural-language instruction for the agent to execute (e.g. "Go to amazon.com and find the best-rated wireless mouse under $50"). Required when dispatching to an existing session.
-             */
-            task?: string | null;
-            /**
-             * @description The model to use. "gemini-3-flash" is fast and cheap, "claude-sonnet-4.6" is balanced, "claude-opus-4.6" is most capable. See BuModel for details.
-             * @default claude-sonnet-4.6
-             */
-            model: components["schemas"]["BuModel"];
-            /**
-             * Sessionid
-             * @description ID of an existing idle session to dispatch the task to. If omitted, a new session is created.
-             */
-            sessionId?: string | null;
-            /**
-             * Keepalive
-             * @description If true, the session stays alive in idle state after the task completes instead of automatically stopping. This lets you dispatch follow-up tasks to the same session, preserving browser state and files.
-             * @default false
-             */
-            keepAlive: boolean;
-            /**
-             * Maxcostusd
-             * @description Maximum total cost in USD allowed for this session. The task will be stopped if this limit is reached. If omitted, a default limit applies (capped by your available balance).
-             */
-            maxCostUsd?: number | string | null;
-            /**
-             * Profileid
-             * @description ID of a browser profile to load into the session. Profiles persist cookies, local storage, and other browser state across sessions. Create profiles via the Profiles API.
-             */
-            profileId?: string | null;
-            /**
-             * Workspaceid
-             * @description ID of a workspace to attach to the session. Workspaces provide persistent file storage that carries across sessions. Create workspaces via the Workspaces API.
-             */
-            workspaceId?: string | null;
-            /**
-             * @description Country code for the browser proxy (e.g. "US", "DE", "JP"). Set to null to disable the proxy. The proxy routes browser traffic through the specified country, useful for accessing geo-restricted content.
-             * @default us
-             */
-            proxyCountryCode: components["schemas"]["ProxyCountryCode"] | null;
-            /**
-             * Outputschema
-             * @description A JSON Schema that the agent's final output must conform to. When set, the agent will return structured data matching this schema in the `output` field of the response. Example: {"type": "object", "properties": {"price": {"type": "number"}, "title": {"type": "string"}}}.
-             */
-            outputSchema?: {
-                [key: string]: unknown;
-            } | null;
-            /**
-             * Enablescheduledtasks
-             * @description If true, the agent can create scheduled tasks that run on a recurring basis (e.g. "every Monday morning, check my inbox and summarize new emails"). Scheduled tasks are tied to your project and persist beyond the session. Note: all scheduled tasks are visible project-wide, so avoid enabling this in multi-user setups where task isolation is needed.
-             * @default false
-             */
-            enableScheduledTasks: boolean;
-            /**
-             * Sensitivedata
-             * @description Key-value pairs of sensitive data (e.g. passwords, API keys) that the agent can use via secure placeholders. Keys are exposed to the LLM; values are never shown. The agent uses `<secret>key</secret>` placeholders in browser_type_text to securely enter values. WARNING: sensitive data may be visible in screenshots if the page renders values in unmasked form fields.
-             */
-            sensitiveData?: {
-                [key: string]: string;
-            } | null;
-            /**
-             * Enablerecording
-             * @description If true, records a video of the browser session. The recording URLs will be available in the `recordingUrls` field of the session response after the task completes.
-             * @default false
-             */
-            enableRecording: boolean;
-            /**
-             * Skills
-             * @description If true, enables built-in agent skills like Google Sheets integration and file management. Set to false to restrict the agent to browser-only actions.
-             * @default true
-             */
-            skills: boolean;
-            /**
-             * Agentmail
-             * @description If true, provisions a temporary email inbox (via AgentMail) for the session. The email address is available in the `agentmailEmail` field of the session response. Useful for tasks that require email verification or sign-ups.
-             * @default true
-             */
-            agentmail: boolean;
-            /**
-             * Cachescript
-             * @description Controls deterministic script caching. `null` (default): auto-detected — enabled when the task contains `@{{value}}` brackets and a workspace is attached. `true`: force-enable script caching even without brackets (caches the exact task). `false`: force-disable, even if brackets are present. When active, the first call runs the full agent and saves a reusable script. Subsequent calls with the same task template execute the cached script with $0 LLM cost. Requires workspace_id when enabled. Example: "Get prices from @{{https://example.com}} for @{{electronics}}".
-             */
-            cacheScript?: boolean | null;
-            /**
-             * Autoheal
-             * @description When cache_script is active, controls whether a lightweight LLM validates the cached script output. If the output looks incorrect (empty, error, wrong structure), the system automatically re-triggers the full agent to generate a new version of the script. Set to false to disable validation and always return the raw script output.
-             * @default true
-             */
-            autoHeal: boolean;
+            /** Prompt */
+            prompt: string;
         };
         /** SessionListResponse */
         SessionListResponse: {
@@ -856,7 +972,7 @@ interface components {
             title?: string | null;
             /**
              * Output
-             * @description The agent's final output. If `outputSchema` was provided, this will be structured data conforming to that schema. Otherwise it may be a free-form string or null. Populated once the task completes, regardless of whether `isTaskSuccessful` is true or false.
+             * @description The agent's final output. If `codeMode` was true, this will be an object with `text` (summary), `code` (Python source), and optionally `output` (execution result). If `outputSchema` was provided, this will be structured data conforming to that schema. Otherwise it may be a free-form string or null.
              */
             output?: unknown | null;
             /**
@@ -962,6 +1078,11 @@ interface components {
              * @description Temporary email address provisioned for this session (via AgentMail). Only present if `agentmail` was enabled.
              */
             agentmailEmail?: string | null;
+            /**
+             * Integrationsused
+             * @description List of integration providers used during this session (e.g. ["gmail", "slack", "agentmail"]).
+             */
+            integrationsUsed?: string[];
             /**
              * Createdat
              * Format: date-time
@@ -986,6 +1107,19 @@ interface components {
              */
             detail: string;
         };
+        /**
+         * ShellResponse
+         * @description Terminal URL — user opens this in their browser, gets a live shell.
+         */
+        ShellResponse: {
+            /** Url */
+            url: string;
+            /**
+             * Expires In Seconds
+             * @default 900
+             */
+            expires_in_seconds: number;
+        };
         /** StopSessionRequest */
         StopSessionRequest: {
             /**
@@ -1003,6 +1137,65 @@ interface components {
          * @enum {string}
          */
         StopStrategy: "task" | "session";
+        /** TelegramInstallRequest */
+        TelegramInstallRequest: {
+            /** Bot Token */
+            bot_token: string;
+        };
+        /** TelegramInstallResponse */
+        TelegramInstallResponse: {
+            /** Installed */
+            installed: boolean;
+            /** Bot Username */
+            bot_username: string;
+            /** Deeplink */
+            deeplink: string;
+            /** Setup Token */
+            setup_token: string;
+        };
+        /**
+         * TgAutoSessionView
+         * @description Snapshot of a QR onboarding session. Returned by start, status, and
+         *     cancel — same shape so the FE renders a single view component.
+         */
+        TgAutoSessionView: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /**
+             * State
+             * @enum {string}
+             */
+            state: "pending_browser" | "waiting_scan" | "login_detected" | "minting" | "installing" | "installed" | "failed" | "expired";
+            /** Live Url */
+            live_url: string | null;
+            /** Bot Username */
+            bot_username: string | null;
+            /** Error Code */
+            error_code: ("bu_cloud_auth" | "bu_cloud_unavailable" | "bu_cloud_rate_limited" | "bu_cloud_timeout" | "scan_timeout" | "agent_dispatch_failed" | "agent_timeout" | "agent_no_output" | "agent_failed" | "invalid_token" | "bot_username_collision" | "rate_limited_botfather" | "box_not_ready" | "tg_already_installed" | "install_telegram_failed" | "box_offline" | "cancelled" | "concurrent_limit" | "internal") | null;
+            /** Error Message */
+            error_message: string | null;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+        };
+        /**
+         * TgAutoStartResponse
+         * @description Returned by POST /me/tg/auto. The session is already running by the
+         *     time this returns — frontend opens the iframe and starts polling.
+         */
+        TgAutoStartResponse: {
+            session: components["schemas"]["TgAutoSessionView"];
+        };
         /**
          * TooManyConcurrentActiveSessionsError
          * @description Error response when user has too many concurrent active sessions
@@ -1014,6 +1207,28 @@ interface components {
              */
             detail: string;
         };
+        /**
+         * TrialEligibilityView
+         * @description GET /me/trial-eligibility — is this user eligible for a free trial?
+         *
+         *     Account-scoped — paid users see this too (one free trial per user,
+         *     regardless of payment tier).
+         *
+         *     `reason` is a stable machine-readable code the FE branches on:
+         *       - 'already_used' — user has already started a trial in their
+         *         lifetime. Render an "upgrade to deploy" CTA.
+         *       - 'no_owner' — couldn't resolve the project's owner profile (rare,
+         *         older projects). FE falls back to generic "add credits" copy.
+         *       - None when eligible=True.
+         */
+        TrialEligibilityView: {
+            /** Eligible */
+            eligible: boolean;
+            /** Reason */
+            reason?: ("already_used" | "no_owner") | null;
+            /** Message */
+            message?: string | null;
+        };
         /**
          * UpdateBrowserSessionRequest
          * @description Request model for updating browser session state.
@@ -1034,6 +1249,50 @@ interface components {
             /** Error Type */
             type: string;
         };
+        /** WindowCreateRequest */
+        WindowCreateRequest: {
+            /** Label */
+            label?: string | null;
+        };
+        /** WindowListResponse */
+        WindowListResponse: {
+            /** Windows */
+            windows: components["schemas"]["WindowView"][];
+        };
+        /** WindowRenameRequest */
+        WindowRenameRequest: {
+            /** Label */
+            label: string;
+        };
+        /**
+         * WindowView
+         * @description One tmux window on the box. id is the tmux session name (`bux-w<n>`).
+         *
+         *     `label` is a user-supplied name (max 64 chars) stored as a tmux
+         *     per-session option (@bux-label). `attached` is True if any tmux
+         *     client is currently connected to the window. The FE shows a small
+         *     indicator next to attached windows so users know which one a phone
+         *     is currently mirroring.
+         */
+        WindowView: {
+            /** Id */
+            id: string;
+            /**
+             * Label
+             * @default
+             */
+            label: string;
+            /**
+             * Attached
+             * @default false
+             */
+            attached: boolean;
+            /**
+             * Created At
+             * @default 0
+             */
+            created_at: number;
+        };
         /**
          * WorkspaceCreateRequest
          * @description Request model for creating a new workspace.
@@ -1111,6 +1370,119 @@ interface components {
              */
             updatedAt: string;
         };
+        /**
+         * RunTaskRequest
+         * @description Create a new session, dispatch a task, or both.
+         *
+         *     - **No `sessionId` + no `task`**: creates an idle session (useful for uploading files before running a task).
+         *     - **No `sessionId` + `task`**: creates a new session and immediately runs the task.
+         *     - **`sessionId` + `task`**: dispatches the task to an existing idle session.
+         *     - **`sessionId` + no `task`**: returns 422 — a task is required when targeting an existing session.
+         */
+        app__endpoints__api__v3__sessions__views__RunTaskRequest: {
+            /**
+             * Task
+             * @description The natural-language instruction for the agent to execute (e.g. "Go to amazon.com and find the best-rated wireless mouse under $50"). Required when dispatching to an existing session.
+             */
+            task?: string | null;
+            /**
+             * @description The model to use. "gemini-3-flash" is fast and cheap, "claude-sonnet-4.6" is balanced, "claude-opus-4.7" is most capable (default). See BuModel for details.
+             * @default claude-opus-4.7
+             */
+            model: components["schemas"]["BuModel"];
+            /**
+             * Sessionid
+             * @description ID of an existing idle session to dispatch the task to. If omitted, a new session is created.
+             */
+            sessionId?: string | null;
+            /**
+             * Keepalive
+             * @description If true, the session stays alive in idle state after the task completes instead of automatically stopping. This lets you dispatch follow-up tasks to the same session, preserving browser state and files.
+             * @default false
+             */
+            keepAlive: boolean;
+            /**
+             * Maxcostusd
+             * @description Maximum total cost in USD allowed for this session. The task will be stopped if this limit is reached. If omitted, a default limit applies (capped by your available balance). When dispatching a follow-up task to an existing session (`sessionId` is set), supplying this value overrides the session's budget for the upcoming dispatch; otherwise the budget is automatically refreshed to current spend + default.
+             */
+            maxCostUsd?: number | string | null;
+            /**
+             * Profileid
+             * @description ID of a browser profile to load into the session. Profiles persist cookies, local storage, and other browser state across sessions. Create profiles via the Profiles API.
+             */
+            profileId?: string | null;
+            /**
+             * Workspaceid
+             * @description ID of a workspace to attach to the session. Workspaces provide persistent file storage that carries across sessions. Create workspaces via the Workspaces API.
+             */
+            workspaceId?: string | null;
+            /**
+             * @description Country code for the browser proxy (e.g. "US", "DE", "JP"). Set to null to disable the proxy. The proxy routes browser traffic through the specified country, useful for accessing geo-restricted content.
+             * @default us
+             */
+            proxyCountryCode: components["schemas"]["ProxyCountryCode"] | null;
+            /**
+             * Outputschema
+             * @description A JSON Schema that the agent's final output must conform to. When set, the agent will return structured data matching this schema in the `output` field of the response. Example: {"type": "object", "properties": {"price": {"type": "number"}, "title": {"type": "string"}}}.
+             */
+            outputSchema?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Enablescheduledtasks
+             * @description If true, the agent can create scheduled tasks that run on a recurring basis (e.g. "every Monday morning, check my inbox and summarize new emails"). Scheduled tasks are tied to your project and persist beyond the session. Note: all scheduled tasks are visible project-wide, so avoid enabling this in multi-user setups where task isolation is needed.
+             * @default false
+             */
+            enableScheduledTasks: boolean;
+            /**
+             * Sensitivedata
+             * @description Key-value pairs of sensitive data (e.g. passwords, API keys) that the agent can use via secure placeholders. Keys are exposed to the LLM; values are never shown. The agent uses `<secret>key</secret>` placeholders in browser_type_text to securely enter values.
+             */
+            sensitiveData?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * Enablerecording
+             * @description If true, records a video of the browser session. The recording URLs will be available in the `recordingUrls` field of the session response after the task completes.
+             * @default false
+             */
+            enableRecording: boolean;
+            /**
+             * Skills
+             * @description If true, enables built-in agent skills like Google Sheets integration and file management. Set to false to restrict the agent to browser-only actions.
+             * @default true
+             */
+            skills: boolean;
+            /**
+             * Agentmail
+             * @description If true, provisions a temporary email inbox (via AgentMail) for the session. The email address is available in the `agentmailEmail` field of the session response. Useful for tasks that require email verification or sign-ups.
+             * @default true
+             */
+            agentmail: boolean;
+            /**
+             * Codemode
+             * @description When true, the agent returns structured output with `text` (summary) and `code` (validated Python source) fields instead of free-form text.
+             * @default false
+             */
+            codeMode: boolean;
+            /**
+             * Cachescript
+             * @description Controls deterministic script caching. `null` (default): auto-detected — enabled when the task contains `@{{value}}` brackets and a workspace is attached. `true`: force-enable script caching even without brackets (caches the exact task). `false`: force-disable, even if brackets are present. When active, the first call runs the full agent and saves a reusable script. Subsequent calls with the same task template execute the cached script with $0 LLM cost. Requires workspace_id when enabled. Example: "Get prices from @{{https://example.com}} for @{{electronics}}".
+             */
+            cacheScript?: boolean | null;
+            /**
+             * Useownkey
+             * @description If true, uses your own LLM API key (configured in project settings) instead of Browser Use managed keys. You pay your provider directly for inference; Browser Use charges a reduced orchestration fee (0.2× of provider list prices). If no key is configured for the model's provider, the request is rejected.
+             * @default false
+             */
+            useOwnKey: boolean;
+            /**
+             * Autoheal
+             * @description When cache_script is active, controls whether a lightweight LLM validates the cached script output. If the output looks incorrect (empty, error, wrong structure), the system automatically re-triggers the full agent to generate a new version of the script. Set to false to disable validation and always return the raw script output.
+             * @default true
+             */
+            autoHeal: boolean;
+        };
     };
     responses: never;
     parameters: never;
@@ -1132,10 +1504,16 @@ type BrowserSessionItemView$1 = components["schemas"]["BrowserSessionItemView"];
 type BrowserSessionView$1 = components["schemas"]["BrowserSessionView"];
 type BrowserSessionListResponse$1 = components["schemas"]["BrowserSessionListResponse"];
 type UpdateBrowserSessionRequest$1 = components["schemas"]["UpdateBrowserSessionRequest"];
+type BrowserDownloadListResponse$1 = components["schemas"]["BrowserDownloadListResponse"];
 interface BrowserListParams {
     page?: number;
     page_size?: number;
 }
+interface BrowserDownloadsParams {
+    limit?: number;
+    cursor?: string;
+    includeUrls?: boolean;
+}
 declare class Browsers {
     private readonly http;
     constructor(http: HttpClient);
@@ -1149,6 +1527,8 @@ declare class Browsers {
     update(sessionId: string, body: UpdateBrowserSessionRequest$1): Promise<BrowserSessionView$1>;
     /** Stop a browser session. Convenience wrapper around update. */
     stop(sessionId: string): Promise<BrowserSessionView$1>;
+    /** List files the browser downloaded to S3 during the session. */
+    downloads(sessionId: string, params?: BrowserDownloadsParams): Promise<BrowserDownloadListResponse$1>;
 }
 
 type ProfileView$1 = components["schemas"]["ProfileView"];
@@ -1175,7 +1555,7 @@ declare class Profiles {
     delete(profileId: string): Promise<void>;
 }
 
-type RunTaskRequest$2 = components["schemas"]["RunTaskRequest"];
+type RunTaskRequest$2 = components["schemas"]["app__endpoints__api__v3__sessions__views__RunTaskRequest"];
 /** All fields optional — omit `task` to create an idle session. */
 type CreateSessionBody = Partial<RunTaskRequest$2>;
 type SessionResponse$2 = components["schemas"]["SessionResponse"];
@@ -1191,9 +1571,13 @@ interface SessionMessagesParams {
     before?: string | null;
     limit?: number;
 }
+interface SessionsOptions {
+    useOwnKey?: boolean;
+}
 declare class Sessions {
     private readonly http;
-    constructor(http: HttpClient);
+    private readonly options;
+    constructor(http: HttpClient, options?: SessionsOptions);
     /** Create a session and optionally dispatch a task. */
     create(body?: CreateSessionBody): Promise<SessionResponse$2>;
     /** List sessions for the authenticated project. */
@@ -1338,12 +1722,29 @@ declare class SessionRun<T = string> implements PromiseLike<SessionResult<T>> {
     private _parseOutput;
 }
 
-type RunTaskRequest$1 = components["schemas"]["RunTaskRequest"];
+type RunTaskRequest$1 = components["schemas"]["app__endpoints__api__v3__sessions__views__RunTaskRequest"];
 interface BrowserUseOptions {
     apiKey?: string;
     baseUrl?: string;
     maxRetries?: number;
     timeout?: number;
+    /**
+     * Use your own LLM API key configured in Browser Use project settings for v3 agent runs.
+     */
+    useOwnKey?: boolean;
+    /**
+     * Pre-built x402 client (advanced — for custom signers / multi-network).
+     * If set, the SDK uses pay-per-request authentication via USDC instead of
+     * an API key. Requires the optional peer deps `@x402/fetch`, `@x402/evm`,
+     * and `viem`.
+     */
+    x402?: X402Client;
+    /**
+     * EVM wallet private key for x402 mode. Equivalent to building an x402
+     * client from this key and passing it as `x402`. Falls back to
+     * `BROWSER_USE_X402_PRIVATE_KEY`.
+     */
+    x402PrivateKey?: string;
 }
 type RunSessionOptions = Partial<Omit<RunTaskRequest$1, "task">> & RunOptions & {
     schema?: z.ZodType;
@@ -1386,12 +1787,14 @@ type MessageListResponse = S["MessageListResponse"];
 type MessageResponse = S["MessageResponse"];
 type WorkspaceView = S["WorkspaceView"];
 type WorkspaceListResponse = S["WorkspaceListResponse"];
-type RunTaskRequest = S["RunTaskRequest"];
+type RunTaskRequest = S["app__endpoints__api__v3__sessions__views__RunTaskRequest"];
 type StopSessionRequest = S["StopSessionRequest"];
 type FileUploadRequest = S["FileUploadRequest"];
 type FileUploadItem = S["FileUploadItem"];
 type WorkspaceCreateRequest = S["WorkspaceCreateRequest"];
 type WorkspaceUpdateRequest = S["WorkspaceUpdateRequest"];
+type BrowserDownloadFile = S["BrowserDownloadFile"];
+type BrowserDownloadListResponse = S["BrowserDownloadListResponse"];
 type BrowserSessionItemView = S["BrowserSessionItemView"];
 type BrowserSessionView = S["BrowserSessionView"];
 type BrowserSessionListResponse = S["BrowserSessionListResponse"];
@@ -1410,4 +1813,4 @@ type BuModel = S["BuModel"];
 type ProxyCountryCode = S["ProxyCountryCode"];
 type StopStrategy = S["StopStrategy"];
 
-export { type AccountView, Billing, type BrowserListParams, type BrowserSessionItemView, type BrowserSessionListResponse, type BrowserSessionStatus, type BrowserSessionUpdateAction, type BrowserSessionView, BrowserUse, type BrowserUseOptions, Browsers, type BuAgentSessionStatus, type BuModel, type CreateBrowserSessionRequest, type CreateSessionBody, type FileInfo, type FileListResponse, type FileUploadItem, type FileUploadRequest, type FileUploadResponse, type FileUploadResponseItem, type MessageListResponse, type MessageResponse, type PlanInfo, type ProfileCreateRequest, type ProfileListParams, type ProfileListResponse, type ProfileUpdateRequest, type ProfileView, Profiles, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionListParams, type SessionListResponse, type SessionMessagesParams, type SessionResponse, type SessionResult, SessionRun, Sessions, type StopSessionRequest, type StopStrategy, type UpdateBrowserSessionRequest, type components as V3Types, type WorkspaceCreateRequest, type WorkspaceFilesParams, type WorkspaceListParams, type WorkspaceListResponse, type WorkspaceUpdateRequest, type WorkspaceView, Workspaces };
+export { type AccountView, Billing, type BrowserDownloadFile, type BrowserDownloadListResponse, type BrowserDownloadsParams, type BrowserListParams, type BrowserSessionItemView, type BrowserSessionListResponse, type BrowserSessionStatus, type BrowserSessionUpdateAction, type BrowserSessionView, BrowserUse, type BrowserUseOptions, Browsers, type BuAgentSessionStatus, type BuModel, type CreateBrowserSessionRequest, type CreateSessionBody, type FileInfo, type FileListResponse, type FileUploadItem, type FileUploadRequest, type FileUploadResponse, type FileUploadResponseItem, type MessageListResponse, type MessageResponse, type PlanInfo, type ProfileCreateRequest, type ProfileListParams, type ProfileListResponse, type ProfileUpdateRequest, type ProfileView, Profiles, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionListParams, type SessionListResponse, type SessionMessagesParams, type SessionResponse, type SessionResult, SessionRun, Sessions, type SessionsOptions, type StopSessionRequest, type StopStrategy, type UpdateBrowserSessionRequest, type components as V3Types, type WorkspaceCreateRequest, type WorkspaceFilesParams, type WorkspaceListParams, type WorkspaceListResponse, type WorkspaceUpdateRequest, type WorkspaceView, Workspaces };