@mendable/firecrawl 4.8.3 → 4.9.1

package/dist/{chunk-KNKWC5EH.js → chunk-POKQQMNV.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.8.3",
+      version: "4.9.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",

package/dist/index.cjs

@@ -35,7 +35,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.8.3",
+      version: "4.9.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -751,6 +751,67 @@ async function extract(http, args) {
   return waitExtract(http, jobId, args.pollInterval ?? 2, args.timeout);
 }
 
+// src/v2/methods/agent.ts
+var import_zod_to_json_schema3 = require("zod-to-json-schema");
+function prepareAgentPayload(args) {
+  const body = {};
+  if (args.urls) body.urls = args.urls;
+  body.prompt = args.prompt;
+  if (args.schema != null) {
+    const s = args.schema;
+    const isZod = s && (typeof s.safeParse === "function" || typeof s.parse === "function") && s._def;
+    body.schema = isZod ? (0, import_zod_to_json_schema3.zodToJsonSchema)(s) : args.schema;
+  }
+  if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
+  return body;
+}
+async function startAgent(http, args) {
+  const payload = prepareAgentPayload(args);
+  try {
+    const res = await http.post("/v2/agent", payload);
+    if (res.status !== 200) throwForBadResponse(res, "agent");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent");
+    throw err;
+  }
+}
+async function getAgentStatus(http, jobId) {
+  try {
+    const res = await http.get(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "agent status");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent status");
+    throw err;
+  }
+}
+async function waitAgent(http, jobId, pollInterval = 2, timeout) {
+  const start = Date.now();
+  while (true) {
+    const status = await getAgentStatus(http, jobId);
+    if (["completed", "failed", "cancelled"].includes(status.status || "")) return status;
+    if (timeout != null && Date.now() - start > timeout * 1e3) return status;
+    await new Promise((r) => setTimeout(r, Math.max(1e3, pollInterval * 1e3)));
+  }
+}
+async function agent(http, args) {
+  const started = await startAgent(http, args);
+  const jobId = started.id;
+  if (!jobId) return started;
+  return waitAgent(http, jobId, args.pollInterval ?? 2, args.timeout);
+}
+async function cancelAgent(http, jobId) {
+  try {
+    const res = await http.delete(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "cancel agent");
+    return res.data?.success === true;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "cancel agent");
+    throw err;
+  }
+}
+
 // src/v2/methods/usage.ts
 async function getConcurrency(http) {
   try {
@@ -1212,6 +1273,38 @@ var FirecrawlClient = class {
   async extract(args) {
     return extract(this.http, args);
   }
+  // Agent
+  /**
+   * Start an agent job (async).
+   * @param args Agent request (urls, prompt, schema).
+   * @returns Job id or processing state.
+   */
+  async startAgent(args) {
+    return startAgent(this.http, args);
+  }
+  /**
+   * Get agent job status/data.
+   * @param jobId Agent job id.
+   */
+  async getAgentStatus(jobId) {
+    return getAgentStatus(this.http, jobId);
+  }
+  /**
+   * Convenience waiter: start an agent and poll until it finishes.
+   * @param args Agent request plus waiter controls (pollInterval, timeout seconds).
+   * @returns Final agent response.
+   */
+  async agent(args) {
+    return agent(this.http, args);
+  }
+  /**
+   * Cancel an agent job.
+   * @param jobId Agent job id.
+   * @returns True if cancelled.
+   */
+  async cancelAgent(jobId) {
+    return cancelAgent(this.http, jobId);
+  }
   // Usage
   /** Current concurrency usage. */
   async getConcurrency() {
@@ -1251,7 +1344,7 @@ var FirecrawlClient = class {
 // src/v1/index.ts
 var import_axios3 = __toESM(require("axios"), 1);
 var zt2 = require("zod");
-var import_zod_to_json_schema3 = require("zod-to-json-schema");
+var import_zod_to_json_schema4 = require("zod-to-json-schema");
 
 // node_modules/typescript-event-target/dist/index.mjs
 var e = class extends EventTarget {
@@ -1323,7 +1416,7 @@ var FirecrawlApp = class {
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1337,7 +1430,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1400,7 +1493,7 @@ var FirecrawlApp = class {
     if (jsonData?.scrapeOptions?.extract?.schema) {
       let schema = jsonData.scrapeOptions.extract.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1669,7 +1762,7 @@ var FirecrawlApp = class {
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1683,7 +1776,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1862,7 +1955,7 @@ var FirecrawlApp = class {
         jsonSchema = void 0;
       } else {
         try {
-          jsonSchema = (0, import_zod_to_json_schema3.zodToJsonSchema)(params.schema);
+          jsonSchema = (0, import_zod_to_json_schema4.zodToJsonSchema)(params.schema);
         } catch (_) {
           jsonSchema = params.schema;
         }
@@ -1926,7 +2019,7 @@ var FirecrawlApp = class {
         jsonSchema = void 0;
       } else {
         try {
-          jsonSchema = (0, import_zod_to_json_schema3.zodToJsonSchema)(params.schema);
+          jsonSchema = (0, import_zod_to_json_schema4.zodToJsonSchema)(params.schema);
         } catch (_) {
           jsonSchema = params.schema;
         }
@@ -2217,7 +2310,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = (0, import_zod_to_json_schema3.zodToJsonSchema)(schema);
+        schema = (0, import_zod_to_json_schema4.zodToJsonSchema)(schema);
       } catch (error) {
       }
       jsonData = {

package/dist/index.d.cts

@@ -283,6 +283,7 @@ interface DocumentMetadata {
     scrapeId?: string;
     numPages?: number;
     contentType?: string;
+    timezone?: string;
     proxyUsed?: 'basic' | 'stealth';
     cacheState?: 'hit' | 'miss';
     cachedAt?: string;
@@ -448,8 +449,21 @@ interface ExtractResponse$1 {
     expiresAt?: string;
     creditsUsed?: number;
 }
+interface AgentResponse {
+    success: boolean;
+    id: string;
+    error?: string;
+}
+interface AgentStatusResponse {
+    success: boolean;
+    status: 'processing' | 'completed' | 'failed';
+    error?: string;
+    data?: unknown;
+    expiresAt: string;
+    creditsUsed?: number;
+}
 interface AgentOptions$1 {
-    model: 'FIRE-1';
+    model: 'FIRE-1' | 'v3-beta';
 }
 interface ConcurrencyCheck {
     concurrency: number;
@@ -567,6 +581,14 @@ declare function prepareExtractPayload(args: {
 }): Record<string, unknown>;
 declare function startExtract(http: HttpClient, args: Parameters<typeof prepareExtractPayload>[0]): Promise<ExtractResponse$1>;
 
+declare function prepareAgentPayload(args: {
+    urls?: string[];
+    prompt: string;
+    schema?: Record<string, unknown> | ZodTypeAny;
+    integration?: string;
+}): Record<string, unknown>;
+declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
+
 type JobKind = "crawl" | "batch";
 interface WatcherOptions {
     kind?: JobKind;
@@ -746,6 +768,32 @@ declare class FirecrawlClient {
         pollInterval?: number;
         timeout?: number;
     }): Promise<ExtractResponse$1>;
+    /**
+     * Start an agent job (async).
+     * @param args Agent request (urls, prompt, schema).
+     * @returns Job id or processing state.
+     */
+    startAgent(args: Parameters<typeof startAgent>[1]): Promise<AgentResponse>;
+    /**
+     * Get agent job status/data.
+     * @param jobId Agent job id.
+     */
+    getAgentStatus(jobId: string): Promise<AgentStatusResponse>;
+    /**
+     * Convenience waiter: start an agent and poll until it finishes.
+     * @param args Agent request plus waiter controls (pollInterval, timeout seconds).
+     * @returns Final agent response.
+     */
+    agent(args: Parameters<typeof startAgent>[1] & {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<AgentStatusResponse>;
+    /**
+     * Cancel an agent job.
+     * @param jobId Agent job id.
+     * @returns True if cancelled.
+     */
+    cancelAgent(jobId: string): Promise<boolean>;
     /** Current concurrency usage. */
     getConcurrency(): Promise<ConcurrencyCheck>;
     /** Current credit usage. */
@@ -811,6 +859,7 @@ interface FirecrawlDocumentMetadata {
     articleSection?: string;
     sourceURL?: string;
     statusCode?: number;
+    timezone?: string;
     error?: string;
     proxyUsed?: "basic" | "stealth";
     cacheState?: "miss" | "hit";
@@ -1670,4 +1719,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.d.ts

@@ -283,6 +283,7 @@ interface DocumentMetadata {
     scrapeId?: string;
     numPages?: number;
     contentType?: string;
+    timezone?: string;
     proxyUsed?: 'basic' | 'stealth';
     cacheState?: 'hit' | 'miss';
     cachedAt?: string;
@@ -448,8 +449,21 @@ interface ExtractResponse$1 {
     expiresAt?: string;
     creditsUsed?: number;
 }
+interface AgentResponse {
+    success: boolean;
+    id: string;
+    error?: string;
+}
+interface AgentStatusResponse {
+    success: boolean;
+    status: 'processing' | 'completed' | 'failed';
+    error?: string;
+    data?: unknown;
+    expiresAt: string;
+    creditsUsed?: number;
+}
 interface AgentOptions$1 {
-    model: 'FIRE-1';
+    model: 'FIRE-1' | 'v3-beta';
 }
 interface ConcurrencyCheck {
     concurrency: number;
@@ -567,6 +581,14 @@ declare function prepareExtractPayload(args: {
 }): Record<string, unknown>;
 declare function startExtract(http: HttpClient, args: Parameters<typeof prepareExtractPayload>[0]): Promise<ExtractResponse$1>;
 
+declare function prepareAgentPayload(args: {
+    urls?: string[];
+    prompt: string;
+    schema?: Record<string, unknown> | ZodTypeAny;
+    integration?: string;
+}): Record<string, unknown>;
+declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
+
 type JobKind = "crawl" | "batch";
 interface WatcherOptions {
     kind?: JobKind;
@@ -746,6 +768,32 @@ declare class FirecrawlClient {
         pollInterval?: number;
         timeout?: number;
     }): Promise<ExtractResponse$1>;
+    /**
+     * Start an agent job (async).
+     * @param args Agent request (urls, prompt, schema).
+     * @returns Job id or processing state.
+     */
+    startAgent(args: Parameters<typeof startAgent>[1]): Promise<AgentResponse>;
+    /**
+     * Get agent job status/data.
+     * @param jobId Agent job id.
+     */
+    getAgentStatus(jobId: string): Promise<AgentStatusResponse>;
+    /**
+     * Convenience waiter: start an agent and poll until it finishes.
+     * @param args Agent request plus waiter controls (pollInterval, timeout seconds).
+     * @returns Final agent response.
+     */
+    agent(args: Parameters<typeof startAgent>[1] & {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<AgentStatusResponse>;
+    /**
+     * Cancel an agent job.
+     * @param jobId Agent job id.
+     * @returns True if cancelled.
+     */
+    cancelAgent(jobId: string): Promise<boolean>;
     /** Current concurrency usage. */
     getConcurrency(): Promise<ConcurrencyCheck>;
     /** Current credit usage. */
@@ -811,6 +859,7 @@ interface FirecrawlDocumentMetadata {
     articleSection?: string;
     sourceURL?: string;
     statusCode?: number;
+    timezone?: string;
     error?: string;
     proxyUsed?: "basic" | "stealth";
     cacheState?: "miss" | "hit";
@@ -1670,4 +1719,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-KNKWC5EH.js";
+} from "./chunk-POKQQMNV.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -633,6 +633,67 @@ async function extract(http, args) {
   return waitExtract(http, jobId, args.pollInterval ?? 2, args.timeout);
 }
 
+// src/v2/methods/agent.ts
+import { zodToJsonSchema as zodToJsonSchema3 } from "zod-to-json-schema";
+function prepareAgentPayload(args) {
+  const body = {};
+  if (args.urls) body.urls = args.urls;
+  body.prompt = args.prompt;
+  if (args.schema != null) {
+    const s = args.schema;
+    const isZod = s && (typeof s.safeParse === "function" || typeof s.parse === "function") && s._def;
+    body.schema = isZod ? zodToJsonSchema3(s) : args.schema;
+  }
+  if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
+  return body;
+}
+async function startAgent(http, args) {
+  const payload = prepareAgentPayload(args);
+  try {
+    const res = await http.post("/v2/agent", payload);
+    if (res.status !== 200) throwForBadResponse(res, "agent");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent");
+    throw err;
+  }
+}
+async function getAgentStatus(http, jobId) {
+  try {
+    const res = await http.get(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "agent status");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent status");
+    throw err;
+  }
+}
+async function waitAgent(http, jobId, pollInterval = 2, timeout) {
+  const start = Date.now();
+  while (true) {
+    const status = await getAgentStatus(http, jobId);
+    if (["completed", "failed", "cancelled"].includes(status.status || "")) return status;
+    if (timeout != null && Date.now() - start > timeout * 1e3) return status;
+    await new Promise((r) => setTimeout(r, Math.max(1e3, pollInterval * 1e3)));
+  }
+}
+async function agent(http, args) {
+  const started = await startAgent(http, args);
+  const jobId = started.id;
+  if (!jobId) return started;
+  return waitAgent(http, jobId, args.pollInterval ?? 2, args.timeout);
+}
+async function cancelAgent(http, jobId) {
+  try {
+    const res = await http.delete(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "cancel agent");
+    return res.data?.success === true;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "cancel agent");
+    throw err;
+  }
+}
+
 // src/v2/methods/usage.ts
 async function getConcurrency(http) {
   try {
@@ -1094,6 +1155,38 @@ var FirecrawlClient = class {
   async extract(args) {
     return extract(this.http, args);
   }
+  // Agent
+  /**
+   * Start an agent job (async).
+   * @param args Agent request (urls, prompt, schema).
+   * @returns Job id or processing state.
+   */
+  async startAgent(args) {
+    return startAgent(this.http, args);
+  }
+  /**
+   * Get agent job status/data.
+   * @param jobId Agent job id.
+   */
+  async getAgentStatus(jobId) {
+    return getAgentStatus(this.http, jobId);
+  }
+  /**
+   * Convenience waiter: start an agent and poll until it finishes.
+   * @param args Agent request plus waiter controls (pollInterval, timeout seconds).
+   * @returns Final agent response.
+   */
+  async agent(args) {
+    return agent(this.http, args);
+  }
+  /**
+   * Cancel an agent job.
+   * @param jobId Agent job id.
+   * @returns True if cancelled.
+   */
+  async cancelAgent(jobId) {
+    return cancelAgent(this.http, jobId);
+  }
   // Usage
   /** Current concurrency usage. */
   async getConcurrency() {
@@ -1133,7 +1226,7 @@ var FirecrawlClient = class {
 // src/v1/index.ts
 import axios2, { AxiosError } from "axios";
 import "zod";
-import { zodToJsonSchema as zodToJsonSchema3 } from "zod-to-json-schema";
+import { zodToJsonSchema as zodToJsonSchema4 } from "zod-to-json-schema";
 
 // node_modules/typescript-event-target/dist/index.mjs
 var e = class extends EventTarget {
@@ -1164,7 +1257,7 @@ var FirecrawlApp = class {
       if (typeof process !== "undefined" && process.env && process.env.npm_package_version) {
         return process.env.npm_package_version;
       }
-      const packageJson = await import("./package-FYCFMQXV.js");
+      const packageJson = await import("./package-YGCUU3YI.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -1205,7 +1298,7 @@ var FirecrawlApp = class {
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1219,7 +1312,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1282,7 +1375,7 @@ var FirecrawlApp = class {
     if (jsonData?.scrapeOptions?.extract?.schema) {
       let schema = jsonData.scrapeOptions.extract.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1551,7 +1644,7 @@ var FirecrawlApp = class {
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1565,7 +1658,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {
@@ -1744,7 +1837,7 @@ var FirecrawlApp = class {
         jsonSchema = void 0;
       } else {
         try {
-          jsonSchema = zodToJsonSchema3(params.schema);
+          jsonSchema = zodToJsonSchema4(params.schema);
         } catch (_) {
           jsonSchema = params.schema;
         }
@@ -1808,7 +1901,7 @@ var FirecrawlApp = class {
         jsonSchema = void 0;
       } else {
         try {
-          jsonSchema = zodToJsonSchema3(params.schema);
+          jsonSchema = zodToJsonSchema4(params.schema);
         } catch (_) {
           jsonSchema = params.schema;
         }
@@ -2099,7 +2192,7 @@ var FirecrawlApp = class {
     if (jsonData?.jsonOptions?.schema) {
       let schema = jsonData.jsonOptions.schema;
       try {
-        schema = zodToJsonSchema3(schema);
+        schema = zodToJsonSchema4(schema);
       } catch (error) {
       }
       jsonData = {

package/dist/{package-FYCFMQXV.js → package-YGCUU3YI.js}

@@ -1,4 +1,4 @@
 import {
   require_package
-} from "./chunk-KNKWC5EH.js";
+} from "./chunk-POKQQMNV.js";
 export default require_package();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl",
-  "version": "4.8.3",
+  "version": "4.9.1",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/v1/index.ts

@@ -49,6 +49,7 @@ export interface FirecrawlDocumentMetadata {
   articleSection?: string;
   sourceURL?: string;
   statusCode?: number;
+  timezone?: string;
   error?: string;
   proxyUsed?: "basic" | "stealth";
   cacheState?: "miss" | "hit";

package/src/v2/client.ts

@@ -19,6 +19,7 @@ import {
   batchScrape as batchWaiter,
 } from "./methods/batch";
 import { startExtract, getExtractStatus, extract as extractWaiter } from "./methods/extract";
+import { startAgent, getAgentStatus, cancelAgent, agent as agentWaiter } from "./methods/agent";
 import { getConcurrency, getCreditUsage, getQueueStatus, getTokenUsage, getCreditUsageHistorical, getTokenUsageHistorical } from "./methods/usage";
 import type {
   Document,
@@ -34,6 +35,8 @@ import type {
   BatchScrapeResponse,
   BatchScrapeJob,
   ExtractResponse,
+  AgentResponse,
+  AgentStatusResponse,
   CrawlOptions,
   BatchScrapeOptions,
   PaginationConfig,
@@ -262,6 +265,39 @@ export class FirecrawlClient {
     return extractWaiter(this.http, args);
   }
 
+  // Agent
+  /**
+   * Start an agent job (async).
+   * @param args Agent request (urls, prompt, schema).
+   * @returns Job id or processing state.
+   */
+  async startAgent(args: Parameters<typeof startAgent>[1]): Promise<AgentResponse> {
+    return startAgent(this.http, args);
+  }
+  /**
+   * Get agent job status/data.
+   * @param jobId Agent job id.
+   */
+  async getAgentStatus(jobId: string): Promise<AgentStatusResponse> {
+    return getAgentStatus(this.http, jobId);
+  }
+  /**
+   * Convenience waiter: start an agent and poll until it finishes.
+   * @param args Agent request plus waiter controls (pollInterval, timeout seconds).
+   * @returns Final agent response.
+   */
+  async agent(args: Parameters<typeof startAgent>[1] & { pollInterval?: number; timeout?: number }): Promise<AgentStatusResponse> {
+    return agentWaiter(this.http, args);
+  }
+  /**
+   * Cancel an agent job.
+   * @param jobId Agent job id.
+   * @returns True if cancelled.
+   */
+  async cancelAgent(jobId: string): Promise<boolean> {
+    return cancelAgent(this.http, jobId);
+  }
+
   // Usage
   /** Current concurrency usage. */
   async getConcurrency() {

package/src/v2/methods/agent.ts

@@ -0,0 +1,82 @@
+import { type AgentResponse, type AgentStatusResponse } from "../types";
+import { HttpClient } from "../utils/httpClient";
+import { normalizeAxiosError, throwForBadResponse } from "../utils/errorHandler";
+import { zodToJsonSchema } from "zod-to-json-schema";
+import type { ZodTypeAny } from "zod";
+
+function prepareAgentPayload(args: {
+  urls?: string[];
+  prompt: string;
+  schema?: Record<string, unknown> | ZodTypeAny;
+  integration?: string;
+}): Record<string, unknown> {
+  const body: Record<string, unknown> = {};
+  if (args.urls) body.urls = args.urls;
+  body.prompt = args.prompt;
+  if (args.schema != null) {
+    const s: any = args.schema;
+    const isZod = s && (typeof s.safeParse === "function" || typeof s.parse === "function") && s._def;
+    body.schema = isZod ? zodToJsonSchema(s) : args.schema;
+  }
+  if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
+  return body;
+}
+
+export async function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse> {
+  const payload = prepareAgentPayload(args);
+  try {
+    const res = await http.post<AgentResponse>("/v2/agent", payload);
+    if (res.status !== 200) throwForBadResponse(res, "agent");
+    return res.data;
+  } catch (err: any) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent");
+    throw err;
+  }
+}
+
+export async function getAgentStatus(http: HttpClient, jobId: string): Promise<AgentStatusResponse> {
+  try {
+    const res = await http.get<AgentStatusResponse>(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "agent status");
+    return res.data;
+  } catch (err: any) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent status");
+    throw err;
+  }
+}
+
+export async function waitAgent(
+  http: HttpClient,
+  jobId: string,
+  pollInterval = 2,
+  timeout?: number
+): Promise<AgentStatusResponse> {
+  const start = Date.now();
+  while (true) {
+    const status = await getAgentStatus(http, jobId);
+    if (["completed", "failed", "cancelled"].includes(status.status || "")) return status;
+    if (timeout != null && Date.now() - start > timeout * 1000) return status;
+    await new Promise((r) => setTimeout(r, Math.max(1000, pollInterval * 1000)));
+  }
+}
+
+export async function agent(
+  http: HttpClient,
+  args: Parameters<typeof prepareAgentPayload>[0] & { pollInterval?: number; timeout?: number }
+): Promise<AgentStatusResponse> {
+  const started = await startAgent(http, args);
+  const jobId = started.id;
+  if (!jobId) return started as unknown as AgentStatusResponse;
+  return waitAgent(http, jobId, args.pollInterval ?? 2, args.timeout);
+}
+
+export async function cancelAgent(http: HttpClient, jobId: string): Promise<boolean> {
+  try {
+    const res = await http.delete<{ success: boolean }>(`/v2/agent/${jobId}`);
+    if (res.status !== 200) throwForBadResponse(res, "cancel agent");
+    return res.data?.success === true;
+  } catch (err: any) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "cancel agent");
+    throw err;
+  }
+}

package/src/v2/types.ts

@@ -347,6 +347,7 @@ export interface DocumentMetadata {
   scrapeId?: string;
   numPages?: number;
   contentType?: string;
+  timezone?: string;
   proxyUsed?: 'basic' | 'stealth';
   cacheState?: 'hit' | 'miss';
   cachedAt?: string;
@@ -534,8 +535,23 @@ export interface ExtractResponse {
   creditsUsed?: number;
 }
 
+export interface AgentResponse {
+  success: boolean;
+  id: string;
+  error?: string;
+}
+
+export interface AgentStatusResponse {
+  success: boolean;
+  status: 'processing' | 'completed' | 'failed';
+  error?: string;
+  data?: unknown;
+  expiresAt: string;
+  creditsUsed?: number;
+}
+
 export interface AgentOptions {
-  model: 'FIRE-1';
+  model: 'FIRE-1' | 'v3-beta';
 }
 
 export interface ConcurrencyCheck {