browser-use-sdk 3.4.2 → 3.5.0

package/dist/v3.d.cts

@@ -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
@@ -712,8 +924,8 @@ interface components {
              */
             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
+             * @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"];
             /**
@@ -729,7 +941,7 @@ interface components {
             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).
+             * @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;
             /**
@@ -760,6 +972,13 @@ interface components {
              * @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.
@@ -778,11 +997,23 @@ interface components {
              * @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.
@@ -849,7 +1080,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;
             /**
@@ -955,6 +1186,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
@@ -979,6 +1215,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: {
             /**
@@ -996,6 +1245,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
@@ -1007,6 +1315,26 @@ interface components {
              */
             detail: string;
         };
+        /**
+         * TrialEligibilityView
+         * @description GET /me/trial-eligibility — is this user eligible for a free trial?
+         *
+         *     `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.
+         *       - 'not_free_tier' — paying customer; FE shows the normal flow.
+         *       - '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" | "not_free_tier" | "no_owner") | null;
+            /** Message */
+            message?: string | null;
+        };
         /**
          * UpdateBrowserSessionRequest
          * @description Request model for updating browser session state.
@@ -1027,6 +1355,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.
@@ -1104,6 +1476,11 @@ interface components {
              */
             updatedAt: string;
         };
+        /** RunTaskRequest */
+        app__endpoints__api__v3__boxes__views__RunTaskRequest: {
+            /** Prompt */
+            prompt: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -1125,10 +1502,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);
@@ -1142,6 +1525,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"];
@@ -1385,6 +1770,8 @@ 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"];
@@ -1403,4 +1790,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 StopSessionRequest, type StopStrategy, type UpdateBrowserSessionRequest, type components as V3Types, type WorkspaceCreateRequest, type WorkspaceFilesParams, type WorkspaceListParams, type WorkspaceListResponse, type WorkspaceUpdateRequest, type WorkspaceView, Workspaces };