@hyperbrowser/sdk 0.34.0 → 0.36.0

package/dist/client.d.ts

@@ -5,7 +5,7 @@ import { CrawlService } from "./services/crawl";
 import { ProfilesService } from "./services/profiles";
 import { ExtensionService } from "./services/extensions";
 import { ExtractService } from "./services/extract";
-import { BrowserUseService } from "./services/beta/agents/browser-use";
+import { BrowserUseService } from "./services/agents/browser-use";
 export declare class HyperbrowserError extends Error {
     statusCode?: number | undefined;
     constructor(message: string, statusCode?: number | undefined);
@@ -17,10 +17,8 @@ export declare class HyperbrowserClient {
     readonly extract: ExtractService;
     readonly profiles: ProfilesService;
     readonly extensions: ExtensionService;
-    readonly beta: {
-        agents: {
-            browserUse: BrowserUseService;
-        };
+    readonly agents: {
+        browserUse: BrowserUseService;
     };
     constructor(config: HyperbrowserConfig);
 }

package/dist/client.js

@@ -7,7 +7,7 @@ const crawl_1 = require("./services/crawl");
 const profiles_1 = require("./services/profiles");
 const extensions_1 = require("./services/extensions");
 const extract_1 = require("./services/extract");
-const browser_use_1 = require("./services/beta/agents/browser-use");
+const browser_use_1 = require("./services/agents/browser-use");
 class HyperbrowserError extends Error {
     constructor(message, statusCode) {
         super(`[Hyperbrowser]: ${message}`);
@@ -30,10 +30,8 @@ class HyperbrowserClient {
         this.extract = new extract_1.ExtractService(apiKey, baseUrl, timeout);
         this.profiles = new profiles_1.ProfilesService(apiKey, baseUrl, timeout);
         this.extensions = new extensions_1.ExtensionService(apiKey, baseUrl, timeout);
-        this.beta = {
-            agents: {
-                browserUse: new browser_use_1.BrowserUseService(apiKey, baseUrl, timeout),
-            },
+        this.agents = {
+            browserUse: new browser_use_1.BrowserUseService(apiKey, baseUrl, timeout),
         };
     }
 }

package/dist/services/{beta/agents → agents}/browser-use.d.ts

@@ -1,6 +1,6 @@
-import { BasicResponse } from "../../../types";
-import { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskResponse, BrowserUseTaskStatusResponse } from "../../../types/beta/agents/browser-use";
-import { BaseService } from "../../base";
+import { BasicResponse } from "../../types";
+import { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskResponse, BrowserUseTaskStatusResponse } from "../../types/agents/browser-use";
+import { BaseService } from "../base";
 export declare class BrowserUseService extends BaseService {
     /**
      * Start a new browser-use task job

package/dist/services/{beta/agents → agents}/browser-use.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrowserUseService = void 0;
-const client_1 = require("../../../client");
-const constants_1 = require("../../../types/constants");
-const utils_1 = require("../../../utils");
-const base_1 = require("../../base");
+const client_1 = require("../../client");
+const constants_1 = require("../../types/constants");
+const utils_1 = require("../../utils");
+const base_1 = require("../base");
 class BrowserUseService extends base_1.BaseService {
     /**
      * Start a new browser-use task job

package/dist/services/crawl.d.ts

@@ -1,4 +1,4 @@
-import { CrawlJobResponse, GetCrawlJobParams, StartCrawlJobParams, StartCrawlJobResponse } from "../types/crawl";
+import { CrawlJobResponse, CrawlJobStatusResponse, GetCrawlJobParams, StartCrawlJobParams, StartCrawlJobResponse } from "../types/crawl";
 import { BaseService } from "./base";
 export declare class CrawlService extends BaseService {
     /**
@@ -6,6 +6,11 @@ export declare class CrawlService extends BaseService {
      * @param params The parameters for the crawl job
      */
     start(params: StartCrawlJobParams): Promise<StartCrawlJobResponse>;
+    /**
+     * Get the status of a crawl job
+     * @param id The ID of the crawl job to get
+     */
+    getStatus(id: string): Promise<CrawlJobStatusResponse>;
     /**
      * Get the status of a crawl job
      * @param id The ID of the crawl job to get

package/dist/services/crawl.js

@@ -24,6 +24,21 @@ class CrawlService extends base_1.BaseService {
             throw new client_1.HyperbrowserError("Failed to start crawl job", undefined);
         }
     }
+    /**
+     * Get the status of a crawl job
+     * @param id The ID of the crawl job to get
+     */
+    async getStatus(id) {
+        try {
+            return await this.request(`/crawl/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get crawl job status ${id}`, undefined);
+        }
+    }
     /**
      * Get the status of a crawl job
      * @param id The ID of the crawl job to get
@@ -33,6 +48,7 @@ class CrawlService extends base_1.BaseService {
         try {
             return await this.request(`/crawl/${id}`, undefined, {
                 page: params?.page,
+                batchSize: params?.batchSize,
             });
         }
         catch (error) {
@@ -53,12 +69,13 @@ class CrawlService extends base_1.BaseService {
         if (!jobId) {
             throw new client_1.HyperbrowserError("Failed to start crawl job, could not get job ID");
         }
-        let jobResponse;
         let failures = 0;
+        let jobStatus = "pending";
         while (true) {
             try {
-                jobResponse = await this.get(jobId, { batchSize: 1 });
-                if (jobResponse.status === "completed" || jobResponse.status === "failed") {
+                const { status } = await this.getStatus(jobId);
+                if (status === "completed" || status === "failed") {
+                    jobStatus = status;
                     break;
                 }
                 failures = 0;
@@ -75,8 +92,7 @@ class CrawlService extends base_1.BaseService {
         if (!returnAllPages) {
             while (true) {
                 try {
-                    jobResponse = await this.get(jobId);
-                    return jobResponse;
+                    return await this.get(jobId);
                 }
                 catch (error) {
                     failures++;
@@ -87,10 +103,18 @@ class CrawlService extends base_1.BaseService {
                 await (0, utils_1.sleep)(500);
             }
         }
-        jobResponse.currentPageBatch = 0;
-        jobResponse.data = [];
         failures = 0;
-        while (jobResponse.currentPageBatch < jobResponse.totalPageBatches) {
+        const jobResponse = {
+            jobId,
+            status: jobStatus,
+            data: [],
+            currentPageBatch: 0,
+            totalPageBatches: 0,
+            totalCrawledPages: 0,
+            batchSize: 100,
+        };
+        let firstCheck = true;
+        while (firstCheck || jobResponse.currentPageBatch < jobResponse.totalPageBatches) {
             try {
                 const tmpJobResponse = await this.get(jobId, {
                     page: jobResponse.currentPageBatch + 1,
@@ -104,6 +128,7 @@ class CrawlService extends base_1.BaseService {
                 jobResponse.totalPageBatches = tmpJobResponse.totalPageBatches;
                 jobResponse.batchSize = tmpJobResponse.batchSize;
                 failures = 0;
+                firstCheck = false;
             }
             catch (error) {
                 failures++;

package/dist/services/extract.d.ts

@@ -1,5 +1,5 @@
 import { BaseService } from "./base";
-import { ExtractJobResponse, StartExtractJobResponse } from "../types/extract";
+import { ExtractJobResponse, ExtractJobStatusResponse, StartExtractJobResponse } from "../types/extract";
 import { StartExtractJobParams } from "../types/extract";
 export declare class ExtractService extends BaseService {
     /**
@@ -11,6 +11,11 @@ export declare class ExtractService extends BaseService {
      * Get the status of an extract job
      * @param id The ID of the extract job to get
      */
+    getStatus(id: string): Promise<ExtractJobStatusResponse>;
+    /**
+     * Get the details of an extract job
+     * @param id The ID of the extract job to get
+     */
     get(id: string): Promise<ExtractJobResponse>;
     /**
      * Start an extract job and wait for it to complete

package/dist/services/extract.js

@@ -44,6 +44,21 @@ class ExtractService extends base_1.BaseService {
      * Get the status of an extract job
      * @param id The ID of the extract job to get
      */
+    async getStatus(id) {
+        try {
+            return await this.request(`/extract/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get extract job status ${id}`, undefined);
+        }
+    }
+    /**
+     * Get the details of an extract job
+     * @param id The ID of the extract job to get
+     */
     async get(id) {
         try {
             return await this.request(`/extract/${id}`);
@@ -65,13 +80,12 @@ class ExtractService extends base_1.BaseService {
         if (!jobId) {
             throw new client_1.HyperbrowserError("Failed to start extract job, could not get job ID");
         }
-        let jobResponse;
         let failures = 0;
         while (true) {
             try {
-                jobResponse = await this.get(jobId);
-                if (jobResponse.status === "completed" || jobResponse.status === "failed") {
-                    break;
+                const { status } = await this.getStatus(jobId);
+                if (status === "completed" || status === "failed") {
+                    return await this.get(jobId);
                 }
                 failures = 0;
             }
@@ -83,7 +97,6 @@ class ExtractService extends base_1.BaseService {
             }
             await (0, utils_1.sleep)(2000);
         }
-        return jobResponse;
     }
 }
 exports.ExtractService = ExtractService;

package/dist/services/scrape.d.ts

@@ -1,4 +1,4 @@
-import { BatchScrapeJobResponse, GetBatchScrapeJobParams, ScrapeJobResponse, StartBatchScrapeJobParams, StartBatchScrapeJobResponse, StartScrapeJobParams, StartScrapeJobResponse } from "../types/scrape";
+import { BatchScrapeJobResponse, BatchScrapeJobStatusResponse, GetBatchScrapeJobParams, ScrapeJobResponse, ScrapeJobStatusResponse, StartBatchScrapeJobParams, StartBatchScrapeJobResponse, StartScrapeJobParams, StartScrapeJobResponse } from "../types/scrape";
 import { BaseService } from "./base";
 export declare class BatchScrapeService extends BaseService {
     /**
@@ -9,6 +9,11 @@ export declare class BatchScrapeService extends BaseService {
     /**
      * Get the status of a batch scrape job
      * @param id The ID of the batch scrape job to get
+     */
+    getStatus(id: string): Promise<BatchScrapeJobStatusResponse>;
+    /**
+     * Get the details of a batch scrape job
+     * @param id The ID of the batch scrape job to get
      * @param params Optional parameters to filter the batch scrape job
      */
     get(id: string, params?: GetBatchScrapeJobParams): Promise<BatchScrapeJobResponse>;
@@ -31,6 +36,11 @@ export declare class ScrapeService extends BaseService {
      * Get the status of a scrape job
      * @param id The ID of the scrape job to get
      */
+    getStatus(id: string): Promise<ScrapeJobStatusResponse>;
+    /**
+     * Get the details of a scrape job
+     * @param id The ID of the scrape job to get
+     */
     get(id: string): Promise<ScrapeJobResponse>;
     /**
      * Start a scrape job and wait for it to complete

package/dist/services/scrape.js

@@ -27,12 +27,28 @@ class BatchScrapeService extends base_1.BaseService {
     /**
      * Get the status of a batch scrape job
      * @param id The ID of the batch scrape job to get
+     */
+    async getStatus(id) {
+        try {
+            return await this.request(`/scrape/batch/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get batch scrape job ${id} status`, undefined);
+        }
+    }
+    /**
+     * Get the details of a batch scrape job
+     * @param id The ID of the batch scrape job to get
      * @param params Optional parameters to filter the batch scrape job
      */
     async get(id, params) {
         try {
             return await this.request(`/scrape/batch/${id}`, undefined, {
                 page: params?.page,
+                batchSize: params?.batchSize,
             });
         }
         catch (error) {
@@ -53,12 +69,13 @@ class BatchScrapeService extends base_1.BaseService {
         if (!jobId) {
             throw new client_1.HyperbrowserError("Failed to start batch scrape job, could not get job ID");
         }
-        let jobResponse;
         let failures = 0;
+        let jobStatus = "pending";
         while (true) {
             try {
-                jobResponse = await this.get(jobId, { batchSize: 1 });
-                if (jobResponse.status === "completed" || jobResponse.status === "failed") {
+                const { status } = await this.getStatus(jobId);
+                if (status === "completed" || status === "failed") {
+                    jobStatus = status;
                     break;
                 }
                 failures = 0;
@@ -75,8 +92,7 @@ class BatchScrapeService extends base_1.BaseService {
         if (!returnAllPages) {
             while (true) {
                 try {
-                    jobResponse = await this.get(jobId);
-                    return jobResponse;
+                    return await this.get(jobId);
                 }
                 catch (error) {
                     failures++;
@@ -87,10 +103,18 @@ class BatchScrapeService extends base_1.BaseService {
                 await (0, utils_1.sleep)(500);
             }
         }
-        jobResponse.currentPageBatch = 0;
-        jobResponse.data = [];
         failures = 0;
-        while (jobResponse.currentPageBatch < jobResponse.totalPageBatches) {
+        const jobResponse = {
+            jobId,
+            status: jobStatus,
+            data: [],
+            currentPageBatch: 0,
+            totalPageBatches: 0,
+            totalScrapedPages: 0,
+            batchSize: 100,
+        };
+        let firstCheck = true;
+        while (firstCheck || jobResponse.currentPageBatch < jobResponse.totalPageBatches) {
             try {
                 const tmpJobResponse = await this.get(jobId, {
                     page: jobResponse.currentPageBatch + 1,
@@ -104,6 +128,7 @@ class BatchScrapeService extends base_1.BaseService {
                 jobResponse.totalPageBatches = tmpJobResponse.totalPageBatches;
                 jobResponse.batchSize = tmpJobResponse.batchSize;
                 failures = 0;
+                firstCheck = false;
             }
             catch (error) {
                 failures++;
@@ -144,6 +169,21 @@ class ScrapeService extends base_1.BaseService {
      * Get the status of a scrape job
      * @param id The ID of the scrape job to get
      */
+    async getStatus(id) {
+        try {
+            return await this.request(`/scrape/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get scrape job status ${id}`, undefined);
+        }
+    }
+    /**
+     * Get the details of a scrape job
+     * @param id The ID of the scrape job to get
+     */
     async get(id) {
         try {
             return await this.request(`/scrape/${id}`);
@@ -165,13 +205,12 @@ class ScrapeService extends base_1.BaseService {
         if (!jobId) {
             throw new client_1.HyperbrowserError("Failed to start scrape job, could not get job ID");
         }
-        let jobResponse;
         let failures = 0;
         while (true) {
             try {
-                jobResponse = await this.get(jobId);
-                if (jobResponse.status === "completed" || jobResponse.status === "failed") {
-                    break;
+                const { status } = await this.getStatus(jobId);
+                if (status === "completed" || status === "failed") {
+                    return await this.get(jobId);
                 }
                 failures = 0;
             }
@@ -183,7 +222,6 @@ class ScrapeService extends base_1.BaseService {
             }
             await (0, utils_1.sleep)(2000);
         }
-        return jobResponse;
     }
 }
 exports.ScrapeService = ScrapeService;

package/dist/tools/anthropic.d.ts

@@ -32,5 +32,7 @@ export interface Tool {
     description?: string;
 }
 export declare const SCRAPE_TOOL_ANTHROPIC: Tool;
+export declare const SCREENSHOT_TOOL_ANTHROPIC: Tool;
 export declare const CRAWL_TOOL_ANTHROPIC: Tool;
 export declare const EXTRACT_TOOL_ANTHROPIC: Tool;
+export declare const BROWSER_USE_TOOL_ANTHROPIC: Tool;

package/dist/tools/anthropic.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
+exports.BROWSER_USE_TOOL_ANTHROPIC = exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCREENSHOT_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_ANTHROPIC = {
     input_schema: schema_1.SCRAPE_SCHEMA,
     name: "scrape_webpage",
     description: "Scrape content from a webpage and return the content in markdown format",
 };
+exports.SCREENSHOT_TOOL_ANTHROPIC = {
+    name: "screenshot_webpage",
+    description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+    input_schema: schema_1.SCREENSHOT_SCHEMA,
+};
 exports.CRAWL_TOOL_ANTHROPIC = {
     input_schema: schema_1.CRAWL_SCHEMA,
     name: "crawl_website",
@@ -17,3 +22,8 @@ exports.EXTRACT_TOOL_ANTHROPIC = {
     name: "extract_data",
     description: "Extract data in a structured format from multiple URLs in a single function call. IMPORTANT: When information must be gathered from multiple sources (such as comparing items, researching topics across sites, or answering questions that span multiple webpages), ALWAYS include all relevant URLs in ONE function call. This enables comprehensive answers with cross-referenced information. Returns data as a json string.",
 };
+exports.BROWSER_USE_TOOL_ANTHROPIC = {
+    input_schema: schema_1.BROWSER_USE_SCHEMA,
+    name: "browser_use",
+    description: "Have an AI agent use a browser to perform a task on the web.",
+};

package/dist/tools/index.d.ts

@@ -1,11 +1,16 @@
 import { HyperbrowserClient } from "../client";
-import { StartScrapeJobParams, StartCrawlJobParams } from "../types";
+import { StartScrapeJobParams, StartCrawlJobParams, StartBrowserUseTaskParams } from "../types";
 import { StartExtractJobParams } from "../types/extract";
 export declare class WebsiteScrapeTool {
     static openaiToolDefinition: import("./openai").ChatCompletionTool;
     static anthropicToolDefinition: import("./anthropic").Tool;
     static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
 }
+export declare class WebsiteScreenshotTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
+}
 export declare class WebsiteCrawlTool {
     static openaiToolDefinition: import("./openai").ChatCompletionTool;
     static anthropicToolDefinition: import("./anthropic").Tool;
@@ -16,3 +21,8 @@ export declare class WebsiteExtractTool {
     static anthropicToolDefinition: import("./anthropic").Tool;
     static runnable(hb: HyperbrowserClient, params: StartExtractJobParams): Promise<string>;
 }
+export declare class BrowserUseTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartBrowserUseTaskParams): Promise<string>;
+}

package/dist/tools/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScrapeTool = void 0;
+exports.BrowserUseTool = exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScreenshotTool = exports.WebsiteScrapeTool = void 0;
 const openai_1 = require("./openai");
 const anthropic_1 = require("./anthropic");
 class WebsiteScrapeTool {
@@ -12,6 +12,15 @@ class WebsiteScrapeTool {
 exports.WebsiteScrapeTool = WebsiteScrapeTool;
 WebsiteScrapeTool.openaiToolDefinition = openai_1.SCRAPE_TOOL_OPENAI;
 WebsiteScrapeTool.anthropicToolDefinition = anthropic_1.SCRAPE_TOOL_ANTHROPIC;
+class WebsiteScreenshotTool {
+    static async runnable(hb, params) {
+        const resp = await hb.scrape.startAndWait(params);
+        return resp.data?.screenshot || "";
+    }
+}
+exports.WebsiteScreenshotTool = WebsiteScreenshotTool;
+WebsiteScreenshotTool.openaiToolDefinition = openai_1.SCREENSHOT_TOOL_OPENAI;
+WebsiteScreenshotTool.anthropicToolDefinition = anthropic_1.SCREENSHOT_TOOL_ANTHROPIC;
 class WebsiteCrawlTool {
     static async runnable(hb, params) {
         const resp = await hb.crawl.startAndWait(params);
@@ -41,3 +50,12 @@ class WebsiteExtractTool {
 exports.WebsiteExtractTool = WebsiteExtractTool;
 WebsiteExtractTool.openaiToolDefinition = openai_1.EXTRACT_TOOL_OPENAI;
 WebsiteExtractTool.anthropicToolDefinition = anthropic_1.EXTRACT_TOOL_ANTHROPIC;
+class BrowserUseTool {
+    static async runnable(hb, params) {
+        const resp = await hb.agents.browserUse.startAndWait(params);
+        return resp.data?.finalResult || "";
+    }
+}
+exports.BrowserUseTool = BrowserUseTool;
+BrowserUseTool.openaiToolDefinition = openai_1.BROWSER_USE_TOOL_OPENAI;
+BrowserUseTool.anthropicToolDefinition = anthropic_1.BROWSER_USE_TOOL_ANTHROPIC;

package/dist/tools/openai.d.ts

@@ -37,5 +37,7 @@ export interface ChatCompletionTool {
     type: "function";
 }
 export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
+export declare const SCREENSHOT_TOOL_OPENAI: ChatCompletionTool;
 export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;
 export declare const EXTRACT_TOOL_OPENAI: ChatCompletionTool;
+export declare const BROWSER_USE_TOOL_OPENAI: ChatCompletionTool;

package/dist/tools/openai.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+exports.BROWSER_USE_TOOL_OPENAI = exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCREENSHOT_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_OPENAI = {
     type: "function",
@@ -11,6 +11,15 @@ exports.SCRAPE_TOOL_OPENAI = {
         strict: true,
     },
 };
+exports.SCREENSHOT_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "screenshot_webpage",
+        description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+        parameters: schema_1.SCREENSHOT_SCHEMA,
+        strict: true,
+    },
+};
 exports.CRAWL_TOOL_OPENAI = {
     type: "function",
     function: {
@@ -29,3 +38,12 @@ exports.EXTRACT_TOOL_OPENAI = {
         strict: true,
     },
 };
+exports.BROWSER_USE_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "browser_use",
+        description: "Have an AI agent use a browser to perform a task on the web.",
+        parameters: schema_1.BROWSER_USE_SCHEMA,
+        strict: true,
+    },
+};

package/dist/tools/schema.d.ts

@@ -1,30 +1,49 @@
-export declare const SCRAPE_OPTIONS: {
-    type: string;
-    description: string;
+export declare const SCRAPE_SCHEMA: {
+    type: "object";
     properties: {
-        includeTags: {
+        url: {
             type: string;
-            items: {
-                type: string;
-            };
             description: string;
         };
-        excludeTags: {
-            type: string;
-            items: {
-                type: string;
-            };
-            description: string;
-        };
-        onlyMainContent: {
+        scrapeOptions: {
             type: string;
             description: string;
+            properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
+                includeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                excludeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                onlyMainContent: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
         };
     };
     required: string[];
     additionalProperties: boolean;
 };
-export declare const SCRAPE_SCHEMA: {
+export declare const SCREENSHOT_SCHEMA: {
     type: "object";
     properties: {
         url: {
@@ -35,6 +54,14 @@ export declare const SCRAPE_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {
@@ -98,6 +125,14 @@ export declare const CRAWL_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {
@@ -150,3 +185,36 @@ export declare const EXTRACT_SCHEMA: {
     required: string[];
     additionalProperties: boolean;
 };
+export declare const BROWSER_USE_SCHEMA: {
+    type: "object";
+    properties: {
+        task: {
+            type: string;
+            description: string;
+        };
+        llm: {
+            description: string;
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        plannerLlm: {
+            description: string;
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        pageExtractionLlm: {
+            description: string;
+            type: string;
+            enum: string[];
+            default: string;
+        };
+        keepBrowserOpen: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/dist/tools/schema.js

@@ -1,40 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCRAPE_SCHEMA = exports.SCRAPE_OPTIONS = void 0;
-exports.SCRAPE_OPTIONS = {
-    type: "object",
-    description: "The options for the scrape",
-    properties: {
-        includeTags: {
-            type: "array",
-            items: {
-                type: "string",
+exports.BROWSER_USE_SCHEMA = exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCREENSHOT_SCHEMA = exports.SCRAPE_SCHEMA = void 0;
+function getScrapeOptions(formats = ["markdown"]) {
+    return {
+        type: "object",
+        description: "The options for the scrape",
+        properties: {
+            formats: {
+                type: "array",
+                description: "The format of the content to scrape",
+                items: {
+                    type: "string",
+                    enum: formats,
+                },
             },
-            description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
-        },
-        excludeTags: {
-            type: "array",
-            items: {
-                type: "string",
+            includeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
+            },
+            excludeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
+            },
+            onlyMainContent: {
+                type: "boolean",
+                description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
             },
-            description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
         },
-        onlyMainContent: {
-            type: "boolean",
-            description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
+        required: ["includeTags", "excludeTags", "onlyMainContent", "formats"],
+        additionalProperties: false,
+    };
+}
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
         },
+        scrapeOptions: getScrapeOptions(),
     },
-    required: ["includeTags", "excludeTags", "onlyMainContent"],
+    required: ["url", "scrapeOptions"],
     additionalProperties: false,
 };
-exports.SCRAPE_SCHEMA = {
+exports.SCREENSHOT_SCHEMA = {
     type: "object",
     properties: {
         url: {
             type: "string",
             description: "The URL of the website to scrape",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(["screenshot"]),
     },
     required: ["url", "scrapeOptions"],
     additionalProperties: false,
@@ -72,7 +94,7 @@ exports.CRAWL_SCHEMA = {
             },
             description: "An array of regular expressions or wildcard patterns specifying which URLs should be included in the crawl. Only pages whose URLs' path match one of these path patterns will be visited. Example: ['/admin', '/careers/*']",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(),
     },
     required: [
         "url",
@@ -111,3 +133,42 @@ exports.EXTRACT_SCHEMA = {
     required: ["urls", "prompt", "schema", "maxLinks"],
     additionalProperties: false,
 };
+const BROWSER_USE_LLM_SCHEMA = {
+    type: "string",
+    enum: [
+        "gpt-4o",
+        "gpt-4o-mini",
+        "claude-3-7-sonnet-20250219",
+        "claude-3-5-sonnet-20241022",
+        "claude-3-5-haiku-20241022",
+        "gemini-2.0-flash",
+    ],
+    default: "gemini-2.0-flash",
+};
+exports.BROWSER_USE_SCHEMA = {
+    type: "object",
+    properties: {
+        task: {
+            type: "string",
+            description: "The text description of the task to be performed by the agent.",
+        },
+        llm: {
+            ...BROWSER_USE_LLM_SCHEMA,
+            description: "The language model (LLM) instance to use for generating actions. Default to gemini-2.0-flash.",
+        },
+        plannerLlm: {
+            ...BROWSER_USE_LLM_SCHEMA,
+            description: "The language model to use specifically for planning future actions, can differ from the main LLM. Default to gemini-2.0-flash.",
+        },
+        pageExtractionLlm: {
+            ...BROWSER_USE_LLM_SCHEMA,
+            description: "The language model to use for extracting structured data from webpages. Default to gemini-2.0-flash.",
+        },
+        keepBrowserOpen: {
+            type: "boolean",
+            description: "When enabled, keeps the browser session open after task completion.",
+        },
+    },
+    required: ["task", "llm", "plannerLlm", "pageExtractionLlm", "keepBrowserOpen"],
+    additionalProperties: false,
+};

package/dist/types/{beta/agents → agents}/browser-use.d.ts

@@ -1,5 +1,5 @@
-import { BrowserUseLlm, BrowserUseTaskStatus } from "../../constants";
-import { CreateSessionParams } from "../../session";
+import { BrowserUseLlm, BrowserUseTaskStatus } from "../constants";
+import { CreateSessionParams } from "../session";
 export interface StartBrowserUseTaskParams {
     task: string;
     llm?: BrowserUseLlm;

package/dist/types/crawl.d.ts

@@ -28,6 +28,9 @@ export interface CrawledPage {
     links?: string[];
     screenshot?: string;
 }
+export interface CrawlJobStatusResponse {
+    status: CrawlJobStatus;
+}
 export interface CrawlJobResponse {
     jobId: string;
     status: CrawlJobStatus;

package/dist/types/extract.d.ts

@@ -13,6 +13,9 @@ export interface StartExtractJobParams {
 export interface StartExtractJobResponse {
     jobId: string;
 }
+export interface ExtractJobStatusResponse {
+    status: ExtractJobStatus;
+}
 export interface ExtractJobResponse {
     jobId: string;
     status: ExtractJobStatus;

package/dist/types/index.d.ts

@@ -1,8 +1,8 @@
 export { HyperbrowserConfig } from "./config";
-export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobResponse, GetCrawlJobParams, } from "./crawl";
-export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, } from "./scrape";
-export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse } from "./extract";
-export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, } from "./beta/agents/browser-use";
+export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobResponse, GetCrawlJobParams, CrawlJobStatusResponse, } from "./crawl";
+export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, } from "./scrape";
+export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, } from "./extract";
+export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, } from "./agents/browser-use";
 export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, } from "./session";
 export { ProfileResponse, CreateProfileResponse, ProfileListParams, ProfileListResponse, } from "./profile";
 export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";

package/dist/types/scrape.d.ts

@@ -22,6 +22,9 @@ export interface StartScrapeJobParams {
 export interface StartScrapeJobResponse {
     jobId: string;
 }
+export interface ScrapeJobStatusResponse {
+    status: ScrapeJobStatus;
+}
 export interface ScrapeJobData {
     metadata?: Record<string, string | string[]>;
     markdown?: string;
@@ -57,6 +60,9 @@ export interface GetBatchScrapeJobParams {
 export interface StartBatchScrapeJobResponse {
     jobId: string;
 }
+export interface BatchScrapeJobStatusResponse {
+    status: ScrapeJobStatus;
+}
 export interface BatchScrapeJobResponse {
     jobId: string;
     status: ScrapeJobStatus;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.34.0",
+  "version": "0.36.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",