comm

Author: maticzav

.env

@@ -0,0 +1 @@
+BROWSER_USE_API_KEY="bu_NnbmRimOkIVSCKaayzv4w_AAm-fsI1xinuLZr_wh71g"

.fernignore

@@ -1 +1,2 @@
 # Specify files that shouldn't be modified by Fern
+src/CustomClient.ts

.vscode/settings.json

@@ -0,0 +1 @@
+{}

examples/.env

@@ -0,0 +1,2 @@
+BROWSER_USE_API_KEY="bu_NnbmRimOkIVSCKaayzv4w_AAm-fsI1xinuLZr_wh71g"
+SECRET_KEY="secret"

examples/.env.example

@@ -0,0 +1,22 @@
+# ----------------------------------------------------------------------------
+# 
+# :GUIDE: 
+# 
+# Copy `.env.example` to `.env` to run all examples without any
+# additional setup. You can also manually export variables
+# and run each example separately.
+# 
+# ----------------------------------------------------------------------------
+
+# API ------------------------------------------------------------------------
+
+# Browser Use API Key
+BROWSER_USE_API_KEY=""
+
+# Webhooks -------------------------------------------------------------------
+
+# NOTE: Use something simple in development. In production, Browser Use Cloud
+#       will give you the production secret.
+SECRET_KEY="secret"
+
+# ----------------------------------------------------------------------------

examples/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store example files demonstrating usage of this SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

examples/retrieve.ts

@@ -0,0 +1,106 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import { BrowserUse } from 'browser-use-sdk';
+
+import { env, spinner } from './utils';
+import z from 'zod';
+
+env();
+
+// gets API Key from environment variable BROWSER_USE_API_KEY
+const browseruse = new BrowserUse();
+
+async function basic() {
+  let log = 'starting';
+  const stop = spinner(() => log);
+
+  // Create Task
+  const rsp = await browseruse.tasks.create({
+    task: "What's the weather line in SF and what's the temperature?",
+    agentSettings: { llm: 'gemini-2.5-flash' },
+  });
+
+  poll: do {
+    // Wait for Task to Finish
+    const status = await browseruse.tasks.retrieve(rsp.id);
+
+    switch (status.status) {
+      case 'started':
+      case 'paused':
+      case 'stopped':
+        log = `agent ${status.status} - live: ${status.session.liveUrl}`;
+
+        await new Promise((resolve) => setTimeout(resolve, 2000));
+        break;
+
+      case 'finished':
+        stop();
+
+        console.log(status.doneOutput);
+        break poll;
+    }
+  } while (true);
+}
+
+// Define Structured Output Schema
+const HackerNewsResponse = z.object({
+  title: z.string(),
+  url: z.string(),
+  score: z.number(),
+});
+
+const TaskOutput = z.object({
+  posts: z.array(HackerNewsResponse),
+});
+
+async function structured() {
+  let log = 'starting';
+  const stop = spinner(() => log);
+
+  // Create Task
+  const rsp = await browseruse.tasks.create({
+    task: 'Extract top 10 Hacker News posts and return the title, url, and score',
+    schema: TaskOutput,
+    agentSettings: { llm: 'gpt-4.1' },
+  });
+
+  poll: do {
+    // Wait for Task to Finish
+    const status = await browseruse.tasks.retrieve({
+      taskId: rsp.id,
+      schema: TaskOutput,
+    });
+
+    switch (status.status) {
+      case 'started':
+      case 'paused':
+      case 'stopped': {
+        log = `agent ${status.status} ${status.session.liveUrl} | ${status.steps.length} steps`;
+
+        await new Promise((resolve) => setTimeout(resolve, 2000));
+
+        break;
+      }
+
+      case 'finished':
+        if (status.parsedOutput == null) {
+          throw new Error('No output');
+        }
+
+        stop();
+
+        // Print Structured Output
+        console.log('Top Hacker News Posts:');
+
+        for (const post of status.parsedOutput.posts) {
+          console.log(` - ${post.title} (${post.score}) ${post.url}`);
+        }
+
+        break poll;
+    }
+  } while (true);
+}
+
+basic()
+  .then(() => structured())
+  .catch(console.error);

examples/run.ts

@@ -0,0 +1,63 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import { BrowserUse } from 'browser-use-sdk';
+import { z } from 'zod';
+
+import { env } from './utils';
+
+env();
+
+// gets API Key from environment variable BROWSER_USE_API_KEY
+const browseruse = new BrowserUse();
+
+async function basic() {
+  console.log(`Basic: Running Task...`);
+
+  // Create Task
+  const rsp = await browseruse.tasks.run({
+    task: "What's the weather line in SF and what's the temperature?",
+    agentSettings: { llm: 'gemini-2.5-flash' },
+  });
+
+  console.log(`Basic: ${rsp.doneOutput}`);
+
+  console.log(`Basic: DONE`);
+}
+
+const HackerNewsResponse = z.object({
+  title: z.string(),
+  url: z.string(),
+});
+
+const TaskOutput = z.object({
+  posts: z.array(HackerNewsResponse),
+});
+
+async function structured() {
+  console.log(`Structured: Running Task...`);
+
+  // Create Task
+  const rsp = await browseruse.tasks.run({
+    task: 'Search for the top 10 Hacker News posts and return the title and url!',
+    schema: TaskOutput,
+    agentSettings: { llm: 'gpt-4.1' },
+  });
+
+  const posts = rsp.parsedOutput?.posts;
+
+  if (posts == null) {
+    throw new Error('Structured: No posts found');
+  }
+
+  console.log(`Structured: Top Hacker News posts:`);
+
+  for (const post of posts) {
+    console.log(` - ${post.title} - ${post.url}`);
+  }
+
+  console.log(`\nStructured: DONE`);
+}
+
+basic()
+  .then(() => structured())
+  .catch(console.error);

examples/stream.ts

@@ -0,0 +1,94 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import { BrowserUse } from 'browser-use-sdk';
+
+import { env } from './utils';
+import z from 'zod';
+
+env();
+
+async function basic() {
+  // gets API Key from environment variable BROWSER_USE_API_KEY
+  const browseruse = new BrowserUse();
+
+  console.log('Basic: Creating task and starting stream...');
+
+  // Create a task and get the stream
+  const task = await browseruse.tasks.create({
+    task: 'What is the weather in San Francisco?',
+    agentSettings: { llm: 'gemini-2.5-flash' },
+  });
+
+  const gen = browseruse.tasks.stream(task.id);
+
+  for await (const msg of gen) {
+    console.log(
+      `Basic: ${msg.data.status} ${msg.data.session.liveUrl} ${msg.data.steps[msg.data.steps.length - 1]?.nextGoal}`,
+    );
+
+    if (msg.data.status === 'finished') {
+      console.log(`Basic: ${msg.data.doneOutput}`);
+    }
+  }
+
+  console.log('\nBasic: Stream completed');
+}
+
+const HackerNewsResponse = z.object({
+  title: z.string(),
+  url: z.string(),
+  score: z.number(),
+});
+
+const TaskOutput = z.object({
+  posts: z.array(HackerNewsResponse),
+});
+
+async function structured() {
+  // gets API Key from environment variable BROWSER_USE_API_KEY
+  const browseruse = new BrowserUse();
+
+  console.log('Structured: Creating task and starting stream...\n');
+
+  // Create a task and get the stream
+  const task = await browseruse.tasks.create({
+    task: 'Extract top 10 Hacker News posts and return the title, url, and score',
+    schema: TaskOutput,
+    agentSettings: { llm: 'gpt-4.1' },
+  });
+
+  const stream = browseruse.tasks.stream({
+    taskId: task.id,
+    schema: TaskOutput,
+  });
+
+  for await (const msg of stream) {
+    // Regular
+    process.stdout.write(`Structured: ${msg.data.status}`);
+    if (msg.data.session.liveUrl) {
+      process.stdout.write(` | Live URL: ${msg.data.session.liveUrl}`);
+    }
+
+    if (msg.data.steps.length > 0) {
+      const latestStep = msg.data.steps[msg.data.steps.length - 1];
+      process.stdout.write(` | ${latestStep!.nextGoal}`);
+    }
+
+    process.stdout.write('\n');
+
+    // Output
+    if (msg.data.status === 'finished') {
+      process.stdout.write(`\n\nOUTPUT:`);
+
+      for (const post of msg.data.parsedOutput!.posts) {
+        process.stdout.write(`\n - ${post.title} (${post.score}) ${post.url}`);
+      }
+    }
+  }
+
+  console.log('\nStructured: Stream completed');
+}
+
+basic()
+  .then(() => structured())
+  .catch(console.error);

examples/utils.ts

@@ -0,0 +1,34 @@
+import dotenv from '@dotenvx/dotenvx';
+
+const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+
+/**
+ * Start a spinner that updates the text every 100ms.
+ *
+ * @param renderText - A function that returns the text to display.
+ * @returns A function to stop the spinner.
+ */
+export function spinner(renderText: () => string): () => void {
+  let frameIndex = 0;
+  const interval = setInterval(() => {
+    const frame = SPINNER_FRAMES[frameIndex++ % SPINNER_FRAMES.length];
+    const text = `${frame} ${renderText()}`;
+    if (typeof process.stdout.clearLine === 'function') {
+      process.stdout.clearLine(0);
+      process.stdout.cursorTo(0);
+    }
+    process.stdout.write(text);
+  }, 100);
+
+  return () => {
+    clearInterval(interval);
+    if (typeof process.stdout.clearLine === 'function') {
+      process.stdout.clearLine(0);
+      process.stdout.cursorTo(0);
+    }
+  };
+}
+
+export function env() {
+  dotenv.config({ path: [__dirname + '/.env', '.env'] });
+}