BrowserUse TypeScript Library

The BrowserUse TypeScript library provides convenient access to the BrowserUse APIs from TypeScript.

Three-Step QuickStart

1. 📦 Install BrowserUse SDK.

   # NPM
   npm i -s browser-use-sdk
   
   # Yarn
   yarn add browser-use-sdk
   
   # PNPM
   pnpm add browser-use-sdk

2. 🔑 Get your API Key at Browser Use Cloud!

3. 🦄 Automate the Internet!

   import { BrowserUseClient } from "browser-use-sdk";
   
   const client = new BrowserUseClient({
       apiKey: "bu_...",
   });
   
   const task = await client.tasks.createTask({
       task: "Search for the top 10 Hacker News posts and return the title and url.",
   });
   
   const result = await task.complete();
   
   console.log(result.output);

The full API of this library can be found in api.md.

---

Structured Output with Zod

import z from "zod";

const TaskOutput = z.object({
    posts: z.array(
        z.object({
            title: z.string(),
            url: z.string(),
        }),
    ),
});

const task = await client.tasks.createTask({
    task: "Search for the top 10 Hacker News posts and return the title and url.",
    schema: TaskOutput,
});

const result = await task.complete();

for (const post of result.parsed.posts) {
    console.log(`${post.title} - ${post.url}`);
}

Streaming Agent Updates

You can use the stream method to get the latest step taken on every change.

const task = await browseruse.tasks.createTask({
    task: "Search for the top 10 Hacker News posts and return the title and url.",
    schema: TaskOutput,
});

for await (const step of task.stream()) {
    console.log(step);
}

const result = await task.complete();

for (const post of result.parsed.posts) {
    console.log(`${post.title} - ${post.url}`);
}

Watching Agent Updates

You can use the watch method to get the latest update on every change.

const task = await browseruse.tasks.createTask({
    task: "Search for the top 10 Hacker News posts and return the title and url.",
    schema: TaskOutput,
});

for await (const update of task.watch()) {
    console.log(update);

    if (update.data.status === "finished") {
        for (const post of update.data.parsed.posts) {
            console.log(`${post.title} - ${post.url}`);
        }
    }
}

Webhook Verification

We encourage you to use the SDK functions that verify and parse webhook events.

import { verifyWebhookEventSignature, type WebhookAgentTaskStatusUpdatePayload } from "browser-use-sdk";

export async function POST(req: Request) {
    const signature = req.headers["x-browser-use-signature"] as string;
    const timestamp = req.headers["x-browser-use-timestamp"] as string;

    const event = await verifyWebhookEventSignature(
        {
            body,
            signature,
            timestamp,
        },
        {
            secret: SECRET_KEY,
        },
    );

    if (!event.ok) {
        return;
    }

    switch (event.event.type) {
        case "agent.task.status_update":
            break;
        case "test":
            break;
        default:
            break;
    }
}

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Installation

npm i -s browser-use-sdk

Reference

A full reference for this library is available here.

Runtime Compatibility

The SDK works in the following runtimes:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+
• React Native

Customizing Fetch Client

The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an unsupported environment, this provides a way for you to break glass and ensure the SDK works.

import { BrowserUseClient } from "browser-use-sdk";

const client = new BrowserUseClient({
    ...
    fetcher: // provide your implementation here
});