browser-use-sdk 3.0.3 → 3.2.0

package/dist/v3.d.cts

@@ -38,6 +38,11 @@ interface components {
         FileListResponse: {
             /** Files */
             files: components["schemas"]["FileInfo"][];
+            /**
+             * Folders
+             * @description Immediate sub-folder names at this prefix level
+             */
+            folders?: string[];
             /** Nextcursor */
             nextCursor?: string | null;
             /**
@@ -46,11 +51,95 @@ interface components {
              */
             hasMore: boolean;
         };
+        /**
+         * FileUploadItem
+         * @description A single file to upload.
+         */
+        FileUploadItem: {
+            /**
+             * Name
+             * @description Filename, e.g. "data.csv"
+             */
+            name: string;
+            /**
+             * Contenttype
+             * @description MIME type, e.g. "text/csv"
+             * @default application/octet-stream
+             */
+            contentType: string;
+            /**
+             * Size
+             * @description File size in bytes (required for workspace uploads)
+             */
+            size?: number | null;
+        };
+        /**
+         * FileUploadRequest
+         * @description Request body for generating presigned upload URLs.
+         */
+        FileUploadRequest: {
+            /** Files */
+            files: components["schemas"]["FileUploadItem"][];
+        };
+        /**
+         * FileUploadResponse
+         * @description Presigned upload URLs for the requested files.
+         */
+        FileUploadResponse: {
+            /** Files */
+            files: components["schemas"]["FileUploadResponseItem"][];
+        };
+        /**
+         * FileUploadResponseItem
+         * @description Presigned upload URL for a single file.
+         */
+        FileUploadResponseItem: {
+            /** Name */
+            name: string;
+            /** Uploadurl */
+            uploadUrl: string;
+            /**
+             * Path
+             * @description S3-relative path, e.g. "uploads/data.csv"
+             */
+            path: string;
+        };
         /** HTTPValidationError */
         HTTPValidationError: {
             /** Detail */
             detail?: components["schemas"]["ValidationError"][];
         };
+        /** MessageListResponse */
+        MessageListResponse: {
+            /** Messages */
+            messages: components["schemas"]["MessageResponse"][];
+            /** Hasmore */
+            hasMore: boolean;
+        };
+        /** MessageResponse */
+        MessageResponse: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /**
+             * Sessionid
+             * Format: uuid
+             */
+            sessionId: string;
+            /** Role */
+            role: string;
+            /** Data */
+            data: string;
+            /** Hidden */
+            hidden: boolean;
+            /**
+             * Createdat
+             * Format: date-time
+             */
+            createdAt: string;
+        };
         /**
          * ProxyCountryCode
          * @enum {string}
@@ -60,12 +149,14 @@ interface components {
          * RunTaskRequest
          * @description Unified request for creating a session or dispatching a task.
          *
-         *     - Without session_id: creates a new session + dispatches the task
-         *     - With session_id: dispatches the task to an existing session
+         *     - Without session_id + without task: creates a new idle session (for file uploads, etc.)
+         *     - Without session_id + with task: creates a new session and dispatches the task
+         *     - With session_id + with task: dispatches the task to an existing idle session
+         *     - With session_id + without task: 422 (task required when dispatching to existing session)
          */
         RunTaskRequest: {
             /** Task */
-            task: string;
+            task?: string | null;
             /** @default bu-mini */
             model: components["schemas"]["BuModel"];
             /** Sessionid */
@@ -79,6 +170,8 @@ interface components {
             maxCostUsd?: number | string | null;
             /** Profileid */
             profileId?: string | null;
+            /** Workspaceid */
+            workspaceId?: string | null;
             proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
             /** Outputschema */
             outputSchema?: {
@@ -109,10 +202,16 @@ interface components {
             title?: string | null;
             /** Output */
             output?: unknown | null;
+            /** Outputschema */
+            outputSchema?: {
+                [key: string]: unknown;
+            } | null;
             /** Liveurl */
             liveUrl?: string | null;
             /** Profileid */
             profileId?: string | null;
+            /** Workspaceid */
+            workspaceId?: string | null;
             proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
             /** Maxcostusd */
             maxCostUsd?: string | null;
@@ -157,6 +256,16 @@ interface components {
              */
             updatedAt: string;
         };
+        /** StopSessionRequest */
+        StopSessionRequest: {
+            /** @default session */
+            strategy: components["schemas"]["StopStrategy"];
+        };
+        /**
+         * StopStrategy
+         * @enum {string}
+         */
+        StopStrategy: "task" | "session";
         /** ValidationError */
         ValidationError: {
             /** Location */
@@ -166,6 +275,83 @@ interface components {
             /** Error Type */
             type: string;
         };
+        /**
+         * WorkspaceCreateRequest
+         * @description Request model for creating a new workspace.
+         */
+        WorkspaceCreateRequest: {
+            /**
+             * Name
+             * @description Optional name for the workspace
+             */
+            name?: string | null;
+        };
+        /**
+         * WorkspaceListResponse
+         * @description Response model for paginated workspace list requests.
+         */
+        WorkspaceListResponse: {
+            /**
+             * Items
+             * @description List of workspace views for the current page
+             */
+            items: components["schemas"]["WorkspaceView"][];
+            /**
+             * Total Items
+             * @description Total number of items in the list
+             */
+            totalItems: number;
+            /**
+             * Page Number
+             * @description Page number
+             */
+            pageNumber: number;
+            /**
+             * Page Size
+             * @description Number of items per page
+             */
+            pageSize: number;
+        };
+        /**
+         * WorkspaceUpdateRequest
+         * @description Request model for updating a workspace.
+         */
+        WorkspaceUpdateRequest: {
+            /**
+             * Name
+             * @description Optional name for the workspace
+             */
+            name?: string | null;
+        };
+        /**
+         * WorkspaceView
+         * @description View model for a workspace — persistent shared storage across sessions.
+         */
+        WorkspaceView: {
+            /**
+             * ID
+             * Format: uuid
+             * @description Unique identifier for the workspace
+             */
+            id: string;
+            /**
+             * Name
+             * @description Optional name for the workspace
+             */
+            name?: string | null;
+            /**
+             * Created At
+             * Format: date-time
+             * @description Timestamp when the workspace was created
+             */
+            createdAt: string;
+            /**
+             * Updated At
+             * Format: date-time
+             * @description Timestamp when the workspace was last updated
+             */
+            updatedAt: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -175,11 +361,15 @@ interface components {
 }
 
 type RunTaskRequest$2 = components["schemas"]["RunTaskRequest"];
-/** Like RunTaskRequest but only `task` is required; fields with server defaults are optional. */
-type CreateSessionBody = Pick<RunTaskRequest$2, "task"> & Partial<Omit<RunTaskRequest$2, "task">>;
+/** All fields optional — omit `task` to create an idle session. */
+type CreateSessionBody = Partial<RunTaskRequest$2>;
 type SessionResponse$2 = components["schemas"]["SessionResponse"];
 type SessionListResponse$1 = components["schemas"]["SessionListResponse"];
-type FileListResponse$1 = components["schemas"]["FileListResponse"];
+type FileListResponse$2 = components["schemas"]["FileListResponse"];
+type StopSessionRequest$1 = components["schemas"]["StopSessionRequest"];
+type FileUploadRequest$2 = components["schemas"]["FileUploadRequest"];
+type FileUploadResponse$2 = components["schemas"]["FileUploadResponse"];
+type MessageListResponse$1 = components["schemas"]["MessageListResponse"];
 interface SessionListParams {
     page?: number;
     page_size?: number;
@@ -189,20 +379,75 @@ interface SessionFilesParams {
     limit?: number;
     cursor?: string | null;
     includeUrls?: boolean;
+    shallow?: boolean;
+}
+interface SessionMessagesParams {
+    after?: string | null;
+    before?: string | null;
+    limit?: number;
 }
 declare class Sessions {
     private readonly http;
     constructor(http: HttpClient);
-    /** Create a session and run a task. */
-    create(body: CreateSessionBody): Promise<SessionResponse$2>;
+    /** Create a session and optionally dispatch a task. */
+    create(body?: CreateSessionBody): Promise<SessionResponse$2>;
     /** List sessions for the authenticated project. */
     list(params?: SessionListParams): Promise<SessionListResponse$1>;
     /** Get session details. */
     get(sessionId: string): Promise<SessionResponse$2>;
-    /** Stop a session. */
-    stop(sessionId: string): Promise<SessionResponse$2>;
+    /** Stop a session or the running task. */
+    stop(sessionId: string, body?: StopSessionRequest$1): Promise<SessionResponse$2>;
+    /** Soft-delete a session. */
+    delete(sessionId: string): Promise<void>;
+    /** Get presigned upload URLs for session files. */
+    uploadFiles(sessionId: string, body: FileUploadRequest$2): Promise<FileUploadResponse$2>;
     /** List files in a session's workspace. */
-    files(sessionId: string, params?: SessionFilesParams): Promise<FileListResponse$1>;
+    files(sessionId: string, params?: SessionFilesParams): Promise<FileListResponse$2>;
+    /** List messages for a session with cursor-based pagination. */
+    messages(sessionId: string, params?: SessionMessagesParams): Promise<MessageListResponse$1>;
+}
+
+type WorkspaceView$1 = components["schemas"]["WorkspaceView"];
+type WorkspaceListResponse$1 = components["schemas"]["WorkspaceListResponse"];
+type WorkspaceCreateRequest$1 = components["schemas"]["WorkspaceCreateRequest"];
+type WorkspaceUpdateRequest$1 = components["schemas"]["WorkspaceUpdateRequest"];
+type FileListResponse$1 = components["schemas"]["FileListResponse"];
+type FileUploadRequest$1 = components["schemas"]["FileUploadRequest"];
+type FileUploadResponse$1 = components["schemas"]["FileUploadResponse"];
+interface WorkspaceListParams {
+    pageSize?: number;
+    pageNumber?: number;
+}
+interface WorkspaceFilesParams {
+    prefix?: string;
+    limit?: number;
+    cursor?: string | null;
+    includeUrls?: boolean;
+    shallow?: boolean;
+}
+declare class Workspaces {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** List workspaces for the authenticated project. */
+    list(params?: WorkspaceListParams): Promise<WorkspaceListResponse$1>;
+    /** Create a new workspace. */
+    create(body?: WorkspaceCreateRequest$1): Promise<WorkspaceView$1>;
+    /** Get workspace details. */
+    get(workspaceId: string): Promise<WorkspaceView$1>;
+    /** Update a workspace. */
+    update(workspaceId: string, body: WorkspaceUpdateRequest$1): Promise<WorkspaceView$1>;
+    /** Delete a workspace and its data. */
+    delete(workspaceId: string): Promise<void>;
+    /** List files in a workspace. */
+    files(workspaceId: string, params?: WorkspaceFilesParams): Promise<FileListResponse$1>;
+    /** Get presigned upload URLs for workspace files. */
+    uploadFiles(workspaceId: string, body: FileUploadRequest$1, query?: {
+        prefix?: string;
+    }): Promise<FileUploadResponse$1>;
+    /** Delete a file from a workspace. */
+    deleteFile(workspaceId: string, path: string): Promise<void>;
+    /** Get storage usage for a workspace. */
+    size(workspaceId: string): Promise<unknown>;
 }
 
 type SessionResponse$1 = components["schemas"]["SessionResponse"];
@@ -253,6 +498,7 @@ type RunSessionOptions = Partial<Omit<RunTaskRequest$1, "task">> & RunOptions &
 };
 declare class BrowserUse {
     readonly sessions: Sessions;
+    readonly workspaces: Workspaces;
     private readonly http;
     constructor(options?: BrowserUseOptions);
     /**
@@ -279,9 +525,21 @@ type SessionResponse = S["SessionResponse"];
 type SessionListResponse = S["SessionListResponse"];
 type FileListResponse = S["FileListResponse"];
 type FileInfo = S["FileInfo"];
+type FileUploadResponse = S["FileUploadResponse"];
+type FileUploadResponseItem = S["FileUploadResponseItem"];
+type MessageListResponse = S["MessageListResponse"];
+type MessageResponse = S["MessageResponse"];
+type WorkspaceView = S["WorkspaceView"];
+type WorkspaceListResponse = S["WorkspaceListResponse"];
 type RunTaskRequest = S["RunTaskRequest"];
+type StopSessionRequest = S["StopSessionRequest"];
+type FileUploadRequest = S["FileUploadRequest"];
+type FileUploadItem = S["FileUploadItem"];
+type WorkspaceCreateRequest = S["WorkspaceCreateRequest"];
+type WorkspaceUpdateRequest = S["WorkspaceUpdateRequest"];
 type BuAgentSessionStatus = S["BuAgentSessionStatus"];
 type BuModel = S["BuModel"];
 type ProxyCountryCode = S["ProxyCountryCode"];
+type StopStrategy = S["StopStrategy"];
 
-export { BrowserUse, type BrowserUseOptions, type BuAgentSessionStatus, type BuModel, type CreateSessionBody, type FileInfo, type FileListResponse, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionFilesParams, type SessionListParams, type SessionListResponse, type SessionResponse, type SessionResult, SessionRun, Sessions, type components as V3Types };
+export { BrowserUse, type BrowserUseOptions, type BuAgentSessionStatus, type BuModel, type CreateSessionBody, type FileInfo, type FileListResponse, type FileUploadItem, type FileUploadRequest, type FileUploadResponse, type FileUploadResponseItem, type MessageListResponse, type MessageResponse, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionFilesParams, type SessionListParams, type SessionListResponse, type SessionMessagesParams, type SessionResponse, type SessionResult, SessionRun, Sessions, type StopSessionRequest, type StopStrategy, type components as V3Types, type WorkspaceCreateRequest, type WorkspaceFilesParams, type WorkspaceListParams, type WorkspaceListResponse, type WorkspaceUpdateRequest, type WorkspaceView, Workspaces };