feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 21
+configured_endpoints: 26
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browser-use%2Fbrowser-use-9ff5409663c58ae9e3ecc9ac764956189e3a70600f5ba1b961bb1dedf0208271.yml
 openapi_spec_hash: 9865acb75430d9b799502acbae860df0
-config_hash: 99e0e445bc20c5723030c315bab52940
+config_hash: 9d52be5177b2ede4cb0633c04f4cc4ef

README.md

@@ -22,11 +22,13 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import BrowserUse from 'browser-use-sdk';
 
-const client = new BrowserUse();
+const client = new BrowserUse({
+  apiKey: process.env['BROWSER_USE_API_KEY'], // This is the default and can be omitted
+});
 
-const tasks = await client.tasks.list();
+const me = await client.users.me.retrieve();
 
-console.log(tasks.items);
+console.log(me.additionalCreditsBalanceUsd);
 ```
 
 ### Request & Response types
@@ -37,9 +39,11 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import BrowserUse from 'browser-use-sdk';
 
-const client = new BrowserUse();
+const client = new BrowserUse({
+  apiKey: process.env['BROWSER_USE_API_KEY'], // This is the default and can be omitted
+});
 
-const tasks: BrowserUse.TaskListResponse = await client.tasks.list();
+const me: BrowserUse.Users.MeRetrieveResponse = await client.users.me.retrieve();
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -52,7 +56,7 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const tasks = await client.tasks.list().catch(async (err) => {
+const me = await client.users.me.retrieve().catch(async (err) => {
   if (err instanceof BrowserUse.APIError) {
     console.log(err.status); // 400
     console.log(err.name); // BadRequestError
@@ -88,12 +92,11 @@ You can use the `maxRetries` option to configure or disable this:
 ```js
 // Configure the default for all requests:
 const client = new BrowserUse({
-  apiKey: 'My API Key',
   maxRetries: 0, // default is 2
 });
 
 // Or, configure per-request:
-await client.tasks.list({
+await client.users.me.retrieve({
   maxRetries: 5,
 });
 ```
@@ -106,12 +109,11 @@ Requests time out after 1 minute by default. You can configure this with a `time
 ```ts
 // Configure the default for all requests:
 const client = new BrowserUse({
-  apiKey: 'My API Key',
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
 // Override per-request:
-await client.tasks.list({
+await client.users.me.retrieve({
   timeout: 5 * 1000,
 });
 ```
@@ -134,13 +136,13 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new BrowserUse();
 
-const response = await client.tasks.list().asResponse();
+const response = await client.users.me.retrieve().asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: tasks, response: raw } = await client.tasks.list().withResponse();
+const { data: me, response: raw } = await client.users.me.retrieve().withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(tasks.items);
+console.log(me.additionalCreditsBalanceUsd);
 ```
 
 ### Logging
@@ -220,7 +222,7 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.tasks.list({
+client.users.me.retrieve({
   // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',

api.md

@@ -1,20 +1,49 @@
+# Users
+
+## Me
+
+Types:
+
+- <code><a href="./src/resources/users/me/me.ts">MeRetrieveResponse</a></code>
+
+Methods:
+
+- <code title="get /users/me">client.users.me.<a href="./src/resources/users/me/me.ts">retrieve</a>() -> MeRetrieveResponse</code>
+
+### Files
+
+Types:
+
+- <code><a href="./src/resources/users/me/files.ts">FileCreatePresignedURLResponse</a></code>
+
+Methods:
+
+- <code title="post /users/me/files/presigned-url">client.users.me.files.<a href="./src/resources/users/me/files.ts">createPresignedURL</a>({ ...params }) -> FileCreatePresignedURLResponse</code>
+
 # Tasks
 
 Types:
 
+- <code><a href="./src/resources/tasks.ts">FileView</a></code>
 - <code><a href="./src/resources/tasks.ts">LlmModel</a></code>
+- <code><a href="./src/resources/tasks.ts">TaskItemView</a></code>
 - <code><a href="./src/resources/tasks.ts">TaskStatus</a></code>
+- <code><a href="./src/resources/tasks.ts">TaskStepView</a></code>
 - <code><a href="./src/resources/tasks.ts">TaskView</a></code>
 - <code><a href="./src/resources/tasks.ts">TaskListResponse</a></code>
-- <code><a href="./src/resources/tasks.ts">TaskRetrieveLogsResponse</a></code>
+- <code><a href="./src/resources/tasks.ts">TaskGetLogsResponse</a></code>
+- <code><a href="./src/resources/tasks.ts">TaskGetOutputFileResponse</a></code>
+- <code><a href="./src/resources/tasks.ts">TaskGetUserUploadedFileResponse</a></code>
 
 Methods:
 
 - <code title="post /tasks">client.tasks.<a href="./src/resources/tasks.ts">create</a>({ ...params }) -> TaskView</code>
 - <code title="get /tasks/{task_id}">client.tasks.<a href="./src/resources/tasks.ts">retrieve</a>(taskID) -> TaskView</code>
 - <code title="patch /tasks/{task_id}">client.tasks.<a href="./src/resources/tasks.ts">update</a>(taskID, { ...params }) -> TaskView</code>
 - <code title="get /tasks">client.tasks.<a href="./src/resources/tasks.ts">list</a>({ ...params }) -> TaskListResponse</code>
-- <code title="get /tasks/{task_id}/logs">client.tasks.<a href="./src/resources/tasks.ts">retrieveLogs</a>(taskID) -> TaskRetrieveLogsResponse</code>
+- <code title="get /tasks/{task_id}/logs">client.tasks.<a href="./src/resources/tasks.ts">getLogs</a>(taskID) -> TaskGetLogsResponse</code>
+- <code title="get /tasks/{task_id}/output-files/{file_id}">client.tasks.<a href="./src/resources/tasks.ts">getOutputFile</a>(fileID, { ...params }) -> TaskGetOutputFileResponse</code>
+- <code title="get /tasks/{task_id}/user-uploaded-files/{file_id}">client.tasks.<a href="./src/resources/tasks.ts">getUserUploadedFile</a>(fileID, { ...params }) -> TaskGetUserUploadedFileResponse</code>
 
 # Sessions
 
@@ -29,6 +58,7 @@ Methods:
 - <code title="get /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">retrieve</a>(sessionID, { ...params }) -> SessionView</code>
 - <code title="patch /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">update</a>(sessionID, { ...params }) -> SessionView</code>
 - <code title="get /sessions">client.sessions.<a href="./src/resources/sessions/sessions.ts">list</a>({ ...params }) -> SessionListResponse</code>
+- <code title="delete /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">delete</a>(sessionID) -> void</code>
 
 ## PublicShare
 

src/client.ts

@@ -34,12 +34,19 @@ import {
   ProxyCountryCode,
 } from './resources/browser-profiles';
 import {
+  FileView,
   LlmModel,
   TaskCreateParams,
+  TaskGetLogsResponse,
+  TaskGetOutputFileParams,
+  TaskGetOutputFileResponse,
+  TaskGetUserUploadedFileParams,
+  TaskGetUserUploadedFileResponse,
+  TaskItemView,
   TaskListParams,
   TaskListResponse,
-  TaskRetrieveLogsResponse,
   TaskStatus,
+  TaskStepView,
   TaskUpdateParams,
   TaskView,
   Tasks,
@@ -53,6 +60,7 @@ import {
   SessionView,
   Sessions,
 } from './resources/sessions/sessions';
+import { Users } from './resources/users/users';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -242,6 +250,10 @@ export class BrowserUse {
     return;
   }
 
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([{ 'X-Browser-Use-API-Key': this.apiKey }]);
+  }
+
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
@@ -679,6 +691,7 @@ export class BrowserUse {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
+      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,
@@ -745,28 +758,39 @@ export class BrowserUse {
 
   static toFile = Uploads.toFile;
 
+  users: API.Users = new API.Users(this);
   tasks: API.Tasks = new API.Tasks(this);
   sessions: API.Sessions = new API.Sessions(this);
   browserProfiles: API.BrowserProfiles = new API.BrowserProfiles(this);
   agentProfiles: API.AgentProfiles = new API.AgentProfiles(this);
 }
+BrowserUse.Users = Users;
 BrowserUse.Tasks = Tasks;
 BrowserUse.Sessions = Sessions;
 BrowserUse.BrowserProfiles = BrowserProfiles;
 BrowserUse.AgentProfiles = AgentProfiles;
 export declare namespace BrowserUse {
   export type RequestOptions = Opts.RequestOptions;
 
+  export { Users as Users };
+
   export {
     Tasks as Tasks,
+    type FileView as FileView,
     type LlmModel as LlmModel,
+    type TaskItemView as TaskItemView,
     type TaskStatus as TaskStatus,
+    type TaskStepView as TaskStepView,
     type TaskView as TaskView,
     type TaskListResponse as TaskListResponse,
-    type TaskRetrieveLogsResponse as TaskRetrieveLogsResponse,
+    type TaskGetLogsResponse as TaskGetLogsResponse,
+    type TaskGetOutputFileResponse as TaskGetOutputFileResponse,
+    type TaskGetUserUploadedFileResponse as TaskGetUserUploadedFileResponse,
     type TaskCreateParams as TaskCreateParams,
     type TaskUpdateParams as TaskUpdateParams,
     type TaskListParams as TaskListParams,
+    type TaskGetOutputFileParams as TaskGetOutputFileParams,
+    type TaskGetUserUploadedFileParams as TaskGetUserUploadedFileParams,
   };
 
   export {

src/internal/utils/log.ts

@@ -106,6 +106,7 @@ export const formatRequestDetails = (details: {
         ([name, value]) => [
           name,
           (
+            name.toLowerCase() === 'x-browser-use-api-key' ||
             name.toLowerCase() === 'authorization' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'

src/resources/index.ts

@@ -28,12 +28,20 @@ export {
 } from './sessions/sessions';
 export {
   Tasks,
+  type FileView,
   type LlmModel,
+  type TaskItemView,
   type TaskStatus,
+  type TaskStepView,
   type TaskView,
   type TaskListResponse,
-  type TaskRetrieveLogsResponse,
+  type TaskGetLogsResponse,
+  type TaskGetOutputFileResponse,
+  type TaskGetUserUploadedFileResponse,
   type TaskCreateParams,
   type TaskUpdateParams,
   type TaskListParams,
+  type TaskGetOutputFileParams,
+  type TaskGetUserUploadedFileParams,
 } from './tasks';
+export { Users } from './users/users';