browser-use-sdk 0.2.1 → 0.3.0

package/src/resources/tasks.ts

@@ -54,7 +54,7 @@ export class Tasks extends APIResource {
    *
    * Returns:
    *
-   * - The created task with its initial details
+   * - The created task ID together with the task's session ID
    *
    * Raises:
    *
@@ -65,17 +65,13 @@ export class Tasks extends APIResource {
   create<T extends ZodType>(
     body: TaskCreateParamsWithSchema<T>,
     options?: RequestOptions,
-  ): APIPromise<TaskViewWithSchema<T>>;
-  create(body: TaskCreateParams, options?: RequestOptions): APIPromise<TaskView>;
+  ): APIPromise<TaskCreateResponse>;
+  create(body: TaskCreateParams, options?: RequestOptions): APIPromise<TaskCreateResponse>;
   create(
     body: TaskCreateParams | TaskCreateParamsWithSchema<ZodType>,
     options?: RequestOptions,
-  ): APIPromise<unknown> {
-    if (body.structuredOutputJson == null || typeof body.structuredOutputJson === 'string') {
-      return this._client.post('/tasks', { body, ...options });
-    }
-
-    if (typeof body.structuredOutputJson === 'object') {
+  ): APIPromise<TaskCreateResponse> {
+    if (body.structuredOutputJson != null && typeof body.structuredOutputJson === 'object') {
       const schema = body.structuredOutputJson;
 
       const _body: TaskCreateParams = {
@@ -83,16 +79,57 @@ export class Tasks extends APIResource {
         structuredOutputJson: stringifyStructuredOutput(schema),
       };
 
-      return this._client
-        .post('/tasks', { body: _body, ...options })
-        ._thenUnwrap((rsp) => parseStructuredTaskOutput(rsp as TaskView, schema));
+      return this._client.post('/tasks', { body: _body, ...options });
     }
 
     return this._client.post('/tasks', { body, ...options });
   }
 
+  /**
+   * Get detailed information about a specific AI agent task.
+   *
+   * Retrieves comprehensive information about a task, including its current status,
+   * progress, and detailed execution data. You can choose to get just the status
+   * (for quick polling) or full details including steps and file information.
+   *
+   * Use this endpoint to:
+   *
+   * - Monitor task progress in real-time
+   * - Review completed task results
+   * - Debug failed tasks by examining steps
+   * - Download output files and logs
+   *
+   * Args:
+   *
+   * - task_id: The unique identifier of the agent task
+   *
+   * Returns:
+   *
+   * - Complete task information
+   *
+   * Raises:
+   *
+   * - 404: If the user agent task doesn't exist
+   */
+  retrieve<T extends ZodType>(
+    req: { taskId: string; schema: T },
+    options?: RequestOptions,
+  ): APIPromise<TaskViewWithSchema<T>>;
+  retrieve(taskID: string, options?: RequestOptions): APIPromise<TaskView>;
+  retrieve(req: string | { taskId: string; schema: ZodType }, options?: RequestOptions): APIPromise<unknown> {
+    if (typeof req === 'string') {
+      return this._client.get(path`/tasks/${req}`, options);
+    }
+
+    const { taskId, schema } = req;
+
+    return this._client
+      .get(path`/tasks/${taskId}`, options)
+      ._thenUnwrap((rsp) => parseStructuredTaskOutput(rsp as TaskView, schema));
+  }
+
   private async *watch(
-    data: TaskCreateParams,
+    taskId: string,
     config: { interval: number },
     options?: RequestOptions,
   ): AsyncGenerator<{ event: 'status'; data: TaskView }> {
@@ -106,14 +143,7 @@ export class Tasks extends APIResource {
 
       tick.current++;
 
-      let status: TaskView;
-
-      // NOTE: We take action on each tick.
-      if (state.current == null) {
-        status = await this.create(data, options);
-      } else {
-        status = await this.retrieve(state.current.taskId);
-      }
+      const status = await this.retrieve(taskId);
 
       const [newState, event] = reducer(state.current, { kind: 'status', status });
 
@@ -132,39 +162,28 @@ export class Tasks extends APIResource {
   }
 
   stream<T extends ZodType>(
-    body: TaskCreateParamsWithSchema<T>,
+    body: {
+      taskId: string;
+      schema: T;
+    },
     options?: RequestOptions,
   ): AsyncGenerator<{ event: 'status'; data: TaskViewWithSchema<T> }>;
-  stream(
-    body: TaskCreateParams,
-    options?: RequestOptions,
-  ): AsyncGenerator<{ event: 'status'; data: TaskView }>;
+  stream(taskId: string, options?: RequestOptions): AsyncGenerator<{ event: 'status'; data: TaskView }>;
   async *stream(
-    body: TaskCreateParams | TaskCreateParamsWithSchema<ZodType>,
+    body: string | { taskId: string; schema: ZodType },
     options?: RequestOptions,
   ): AsyncGenerator<unknown> {
     let req: TaskCreateParams;
 
-    if (
-      'structuredOutputJson' in body &&
-      body.structuredOutputJson != null &&
-      typeof body.structuredOutputJson === 'object'
-    ) {
-      req = {
-        ...body,
-        structuredOutputJson: stringifyStructuredOutput(body.structuredOutputJson),
-      };
-    } else {
-      req = body as TaskCreateParams;
-    }
+    const taskId = typeof body === 'object' ? body.taskId : body;
 
-    for await (const msg of this.watch(req, { interval: 500 }, options)) {
+    for await (const msg of this.watch(taskId, { interval: 500 }, options)) {
       if (options?.signal?.aborted) {
         break;
       }
 
-      if (body.structuredOutputJson != null && typeof body.structuredOutputJson === 'object') {
-        const parsed = parseStructuredTaskOutput<ZodType>(msg.data, body.structuredOutputJson);
+      if (typeof body === 'object') {
+        const parsed = parseStructuredTaskOutput<ZodType>(msg.data, body.schema);
         yield { event: 'status', data: parsed };
       } else {
         yield { event: 'status', data: msg.data };
@@ -172,49 +191,6 @@ export class Tasks extends APIResource {
     }
   }
 
-  /**
-   * Get detailed information about a specific AI agent task.
-   *
-   * Retrieves comprehensive information about a task, including its current status,
-   * progress, and detailed execution data. You can choose to get just the status
-   * (for quick polling) or full details including steps and file information.
-   *
-   * Use this endpoint to:
-   *
-   * - Monitor task progress in real-time
-   * - Review completed task results
-   * - Debug failed tasks by examining steps
-   * - Download output files and logs
-   *
-   * Args:
-   *
-   * - task_id: The unique identifier of the agent task
-   *
-   * Returns:
-   *
-   * - Complete task information
-   *
-   * Raises:
-   *
-   * - 404: If the user agent task doesn't exist
-   */
-  retrieve<T extends ZodType>(
-    req: { taskId: string; schema: T },
-    options?: RequestOptions,
-  ): APIPromise<TaskViewWithSchema<T>>;
-  retrieve(taskID: string, options?: RequestOptions): APIPromise<TaskView>;
-  retrieve(req: string | { taskId: string; schema: ZodType }, options?: RequestOptions): APIPromise<unknown> {
-    if (typeof req === 'string') {
-      return this._client.get(path`/tasks/${req}`, options);
-    }
-
-    const { taskId, schema } = req;
-
-    return this._client
-      .get(path`/tasks/${taskId}`, options)
-      ._thenUnwrap((rsp) => parseStructuredTaskOutput(rsp as TaskView, schema));
-  }
-
   /**
    * Control the execution of an AI agent task.
    *
@@ -561,6 +537,18 @@ export interface TaskView {
   sessionLiveUrl?: string | null;
 }
 
+/**
+ * Response model for creating a task
+ *
+ * Attributes: task_id: An unique identifier for the created task session_id: The
+ * ID of the session this task belongs to
+ */
+export interface TaskCreateResponse {
+  id: string;
+
+  sessionId: string;
+}
+
 /**
  * Response model for paginated task list requests
  *
@@ -711,6 +699,7 @@ export declare namespace Tasks {
     type TaskStatus as TaskStatus,
     type TaskStepView as TaskStepView,
     type TaskView as TaskView,
+    type TaskCreateResponse as TaskCreateResponse,
     type TaskListResponse as TaskListResponse,
     type TaskGetLogsResponse as TaskGetLogsResponse,
     type TaskGetOutputFileResponse as TaskGetOutputFileResponse,

package/src/resources/users/me/files.ts

@@ -45,7 +45,7 @@ export class Files extends APIResource {
 }
 
 /**
- * Response model for presigned upload URL
+ * Response model for a presigned upload URL
  *
  * Attributes: url: The URL to upload the file to method: The HTTP method to use
  * for the upload fields: The form fields to include in the upload request

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.3.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.2.1'; // x-release-please-version
+exports.VERSION = '0.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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