browser-use-sdk 0.3.0 → 0.5.0

package/src/resources/tasks.ts

@@ -226,25 +226,18 @@ export class Tasks extends APIResource {
   }
 
   /**
-   * Get a paginated list of all AI agent tasks for the authenticated user.
+   * Get a paginated list of all Browser Use Agent tasks for the authenticated user.
    *
-   * AI agent tasks are the individual jobs that your agents perform within a
-   * session. Each task represents a specific instruction or goal that the agent
+   * Browser Use Agent tasks are the individual jobs that your agents perform within
+   * a session. Each task represents a specific instruction or goal that the agent
    * works on, such as filling out a form, extracting data, or navigating to specific
    * pages.
    *
-   * You can control what data is included for each task:
-   *
-   * - Task steps: Detailed actions the agent took
-   * - User uploaded files: Files you provided for the task
-   * - Output files: Files generated by the agent during the task
-   *
    * Returns:
    *
-   * - A paginated list of agent tasks
-   * - Total count of tasks
+   * - A paginated list of Browser Use Agent tasks
+   * - Total count of Browser Use Agent tasks
    * - Page information for navigation
-   * - Optional detailed data based on your parameters
    */
   list(
     query: TaskListParams | null | undefined = {},
@@ -390,18 +383,18 @@ export type LlmModel =
  * View model for representing a task with its execution details
  *
  * Attributes: id: Unique identifier for the task session_id: ID of the session
- * this task belongs to session_live_url: Optional live URL of the session llm: The
- * LLM model used for this task task: The task prompt/instruction given to the
- * agent status: Current status of the task execution started_at: Naive UTC
- * timestamp when the task was started finished_at: Naive UTC timestamp when the
- * task completed (None if still running) metadata: Optional additional metadata
- * associated with the task set by the user is_scheduled: Whether this task was
- * created as a scheduled task steps: Optional list of execution steps done_output:
- * Final output/result of the task user_uploaded_files: Optional list of files
- * uploaded by user for this task output_files: Optional list of files generated as
- * output by this task browser_use_version: Version of browser-use used for this
- * task (older tasks may not have this set) is_success: Whether the task was
- * successful (self-reported by the agent)
+ * this task belongs to llm: The LLM model used for this task task: The task
+ * prompt/instruction given to the agent status: Current status of the task
+ * execution started_at: Naive UTC timestamp when the task was started finished_at:
+ * Naive UTC timestamp when the task completed (None if still running) metadata:
+ * Optional additional metadata associated with the task set by the user
+ * is_scheduled: Whether this task was created as a scheduled task steps: Optional
+ * list of execution steps done_output: Final output/result of the task
+ * user_uploaded_files: Optional list of files uploaded by user for this task
+ * output_files: Optional list of files generated as output by this task
+ * browser_use_version: Version of browser-use used for this task (older tasks may
+ * not have this set) is_success: Whether the task was successful (self-reported by
+ * the agent)
  */
 export interface TaskItemView {
   id: string;
@@ -417,9 +410,10 @@ export interface TaskItemView {
   /**
    * Enumeration of possible task execution states
    *
-   * Attributes: STARTED: Task has been started and is currently running PAUSED: Task
-   * execution has been temporarily paused (can be resumed) STOPPED: Task execution
-   * has been stopped (cannot be resumed) FINISHED: Task has completed successfully
+   * Attributes: STARTED: Task has been started and is currently running. PAUSED:
+   * Task execution has been temporarily paused (can be resumed) FINISHED: Task has
+   * finished and the agent has completed the task. STOPPED: Task execution has been
+   * manually stopped (cannot be resumed).
    */
   status: TaskStatus;
 
@@ -434,24 +428,17 @@ export interface TaskItemView {
   isSuccess?: boolean | null;
 
   metadata?: { [key: string]: unknown };
-
-  outputFiles?: Array<FileView> | null;
-
-  sessionLiveUrl?: string | null;
-
-  steps?: Array<TaskStepView> | null;
-
-  userUploadedFiles?: Array<FileView> | null;
 }
 
 /**
  * Enumeration of possible task execution states
  *
- * Attributes: STARTED: Task has been started and is currently running PAUSED: Task
- * execution has been temporarily paused (can be resumed) STOPPED: Task execution
- * has been stopped (cannot be resumed) FINISHED: Task has completed successfully
+ * Attributes: STARTED: Task has been started and is currently running. PAUSED:
+ * Task execution has been temporarily paused (can be resumed) FINISHED: Task has
+ * finished and the agent has completed the task. STOPPED: Task execution has been
+ * manually stopped (cannot be resumed).
  */
-export type TaskStatus = 'started' | 'paused' | 'stopped' | 'finished';
+export type TaskStatus = 'started' | 'paused' | 'finished' | 'stopped';
 
 /**
  * View model for representing a single step in a task's execution
@@ -483,11 +470,11 @@ export interface TaskStepView {
  * View model for representing a task with its execution details
  *
  * Attributes: id: Unique identifier for the task session_id: ID of the session
- * this task belongs to session_live_url: Optional live URL of the session llm: The
- * LLM model used for this task task: The task prompt/instruction given to the
- * agent status: Current status of the task execution started_at: Naive UTC
- * timestamp when the task was started finished_at: Naive UTC timestamp when the
- * task completed (None if still running) metadata: Optional additional metadata
+ * this task belongs to session: The session this task belongs to llm: The LLM
+ * model used for this task task: The task prompt/instruction given to the agent
+ * status: Current status of the task execution started_at: Naive UTC timestamp
+ * when the task was started finished_at: Naive UTC timestamp when the task
+ * completed (None if still running) metadata: Optional additional metadata
  * associated with the task set by the user is_scheduled: Whether this task was
  * created as a scheduled task steps: List of execution steps done_output: Final
  * output/result of the task user_uploaded_files: List of files uploaded by user
@@ -505,6 +492,16 @@ export interface TaskView {
 
   outputFiles: Array<FileView>;
 
+  /**
+   * View model for representing a session that a task belongs to
+   *
+   * Attributes: id: Unique identifier for the session status: Current status of the
+   * session (active/stopped) live_url: URL where the browser can be viewed live in
+   * real-time. started_at: Timestamp when the session was created and started.
+   * finished_at: Timestamp when the session was stopped (None if still active).
+   */
+  session: TaskView.Session;
+
   sessionId: string;
 
   startedAt: string;
@@ -512,9 +509,10 @@ export interface TaskView {
   /**
    * Enumeration of possible task execution states
    *
-   * Attributes: STARTED: Task has been started and is currently running PAUSED: Task
-   * execution has been temporarily paused (can be resumed) STOPPED: Task execution
-   * has been stopped (cannot be resumed) FINISHED: Task has completed successfully
+   * Attributes: STARTED: Task has been started and is currently running. PAUSED:
+   * Task execution has been temporarily paused (can be resumed) FINISHED: Task has
+   * finished and the agent has completed the task. STOPPED: Task execution has been
+   * manually stopped (cannot be resumed).
    */
   status: TaskStatus;
 
@@ -533,8 +531,34 @@ export interface TaskView {
   isSuccess?: boolean | null;
 
   metadata?: { [key: string]: unknown };
+}
+
+export namespace TaskView {
+  /**
+   * View model for representing a session that a task belongs to
+   *
+   * Attributes: id: Unique identifier for the session status: Current status of the
+   * session (active/stopped) live_url: URL where the browser can be viewed live in
+   * real-time. started_at: Timestamp when the session was created and started.
+   * finished_at: Timestamp when the session was stopped (None if still active).
+   */
+  export interface Session {
+    id: string;
+
+    startedAt: string;
 
-  sessionLiveUrl?: string | null;
+    /**
+     * Enumeration of possible (browser) session states
+     *
+     * Attributes: ACTIVE: Session is currently active and running (browser is running)
+     * STOPPED: Session has been stopped and is no longer active (browser is stopped)
+     */
+    status: 'active' | 'stopped';
+
+    finishedAt?: string | null;
+
+    liveUrl?: string | null;
+  }
 }
 
 /**
@@ -576,29 +600,40 @@ export interface TaskGetLogsResponse {
 /**
  * Response model for output file requests
  *
- * Attributes: download_url: URL to download the output file
+ * Attributes: id: Unique identifier for the output file file_name: Name of the
+ * output file download_url: URL to download the output file
  */
 export interface TaskGetOutputFileResponse {
+  id: string;
+
   downloadUrl: string;
+
+  fileName: string;
 }
 
 /**
  * Response model for user uploaded file requests
  *
- * Attributes: download_url: URL to download the user uploaded file
+ * Attributes: id: Unique identifier for the user uploaded file file_name: Name of
+ * the user uploaded file download_url: URL to download the user uploaded file
  */
 export interface TaskGetUserUploadedFileResponse {
+  id: string;
+
   downloadUrl: string;
+
+  fileName: string;
 }
 
 export interface TaskCreateParams {
   task: string;
 
   /**
-   * Configuration settings for the AI agent
+   * Configuration settings for the agent
    *
-   * Attributes: llm: The LLM model to use for the agent profile_id: Unique
-   * identifier of the agent profile to use for the task
+   * Attributes: llm: The LLM model to use for the agent start_url: Optional URL to
+   * start the agent on (will not be changed as a step) profile_id: Unique identifier
+   * of the agent profile to use for the task
    */
   agentSettings?: TaskCreateParams.AgentSettings;
 
@@ -606,8 +641,8 @@ export interface TaskCreateParams {
    * Configuration settings for the browser session
    *
    * Attributes: session_id: Unique identifier of existing session to continue
-   * profile_id: Unique identifier of browser profile to use save_browser_data:
-   * Whether to save browser state/data for the user to download later
+   * profile_id: Unique identifier of browser profile to use (use if you want to
+   * start a new session)
    */
   browserSettings?: TaskCreateParams.BrowserSettings;
 
@@ -622,29 +657,30 @@ export interface TaskCreateParams {
 
 export namespace TaskCreateParams {
   /**
-   * Configuration settings for the AI agent
+   * Configuration settings for the agent
    *
-   * Attributes: llm: The LLM model to use for the agent profile_id: Unique
-   * identifier of the agent profile to use for the task
+   * Attributes: llm: The LLM model to use for the agent start_url: Optional URL to
+   * start the agent on (will not be changed as a step) profile_id: Unique identifier
+   * of the agent profile to use for the task
    */
   export interface AgentSettings {
     llm?: TasksAPI.LlmModel;
 
     profileId?: string | null;
+
+    startUrl?: string | null;
   }
 
   /**
    * Configuration settings for the browser session
    *
    * Attributes: session_id: Unique identifier of existing session to continue
-   * profile_id: Unique identifier of browser profile to use save_browser_data:
-   * Whether to save browser state/data for the user to download later
+   * profile_id: Unique identifier of browser profile to use (use if you want to
+   * start a new session)
    */
   export interface BrowserSettings {
     profileId?: string | null;
 
-    saveBrowserData?: boolean;
-
     sessionId?: string | null;
   }
 }
@@ -661,20 +697,19 @@ export interface TaskUpdateParams {
 }
 
 export interface TaskListParams {
+  after?: string | null;
+
+  before?: string | null;
+
   /**
-   * Enumeration of possible task filters
+   * Enumeration of possible task execution states
    *
-   * Attributes: STARTED: All started tasks PAUSED: All paused tasks STOPPED: All
-   * stopped tasks FINISHED: All finished tasks SUCCESSFUL: All successful tasks
-   * UNSUCCESSFUL: All unsuccessful tasks
+   * Attributes: STARTED: Task has been started and is currently running. PAUSED:
+   * Task execution has been temporarily paused (can be resumed) FINISHED: Task has
+   * finished and the agent has completed the task. STOPPED: Task execution has been
+   * manually stopped (cannot be resumed).
    */
-  filterBy?: 'started' | 'paused' | 'stopped' | 'finished' | 'successful' | 'unsuccessful' | null;
-
-  includeOutputFiles?: boolean;
-
-  includeSteps?: boolean;
-
-  includeUserUploadedFiles?: boolean;
+  filterBy?: TaskStatus | null;
 
   pageNumber?: number;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.5.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.5.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.0'; // x-release-please-version
+exports.VERSION = '0.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map