import * as ai from 'ai'; import { Tool } from 'ai'; import * as _mendable_firecrawl_js from '@mendable/firecrawl-js'; import { CrawlJob, BatchScrapeJob } from '@mendable/firecrawl-js'; import { z } from 'zod'; declare const scrape: DualTool<{ url: string; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; }, Omit<_mendable_firecrawl_js.Document, "json"> & { json?: unknown; }>; declare const search: DualTool<{ query: string; country?: string | undefined; location?: string | undefined; timeout?: number | undefined; limit?: number | undefined; tbs?: string | undefined; sources?: { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }[] | undefined; categories?: { type: "pdf" | "github" | "research"; }[] | undefined; ignoreInvalidURLs?: boolean | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; }, _mendable_firecrawl_js.SearchData>; declare const map: DualTool<{ url: string; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; timeout?: number | undefined; limit?: number | undefined; search?: string | undefined; includeSubdomains?: boolean | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | "only" | undefined; }, _mendable_firecrawl_js.MapData>; declare const interactSchema: z.ZodEffects; prompt: z.ZodOptional; code: z.ZodOptional; language: z.ZodOptional>; timeout: z.ZodOptional; }, "strip", z.ZodTypeAny, { url?: string | undefined; code?: string | undefined; prompt?: string | undefined; timeout?: number | undefined; language?: "node" | "python" | "bash" | undefined; }, { url?: string | undefined; code?: string | undefined; prompt?: string | undefined; timeout?: number | undefined; language?: "node" | "python" | "bash" | undefined; }>, { url?: string | undefined; code?: string | undefined; prompt?: string | undefined; timeout?: number | undefined; language?: "node" | "python" | "bash" | undefined; }, { url?: string | undefined; code?: string | undefined; prompt?: string | undefined; timeout?: number | undefined; language?: "node" | "python" | "bash" | undefined; }>; declare const scrapeSchema: z.ZodObject<{ url: z.ZodString; formats: z.ZodOptional, z.ZodObject<{ type: z.ZodLiteral<"json">; prompt: z.ZodOptional; schema: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"screenshot">; fullPage: z.ZodOptional; quality: z.ZodOptional; viewport: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"query">; prompt: z.ZodString; }, "strip", z.ZodTypeAny, { type: "query"; prompt: string; }, { type: "query"; prompt: string; }>]>, "many">>; parsers: z.ZodOptional, z.ZodObject<{ type: z.ZodEnum<["pdf"]>; maxPages: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "pdf"; maxPages?: number | undefined; }, { type: "pdf"; maxPages?: number | undefined; }>]>, "many">>; onlyMainContent: z.ZodOptional; includeTags: z.ZodOptional>; excludeTags: z.ZodOptional>; waitFor: z.ZodOptional; actions: z.ZodOptional; selector: z.ZodOptional; milliseconds: z.ZodOptional; text: z.ZodOptional; key: z.ZodOptional; direction: z.ZodOptional>; script: z.ZodOptional; fullPage: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }>, "many">>; mobile: z.ZodOptional; skipTlsVerification: z.ZodOptional; removeBase64Images: z.ZodOptional; location: z.ZodOptional; languages: z.ZodOptional>; }, "strip", z.ZodTypeAny, { country?: string | undefined; languages?: string[] | undefined; }, { country?: string | undefined; languages?: string[] | undefined; }>>; storeInCache: z.ZodOptional; maxAge: z.ZodOptional; headers: z.ZodOptional>; blockAds: z.ZodOptional; proxy: z.ZodOptional>; zeroDataRetention: z.ZodOptional; timeout: z.ZodOptional; }, "strip", z.ZodTypeAny, { url: string; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; }, { url: string; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; }>; declare const searchSchema: z.ZodObject<{ query: z.ZodString; limit: z.ZodOptional; sources: z.ZodOptional; tbs: z.ZodOptional; location: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }, { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }>, "many">>; categories: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "pdf" | "github" | "research"; }, { type: "pdf" | "github" | "research"; }>, "many">>; tbs: z.ZodOptional; location: z.ZodOptional; country: z.ZodOptional; timeout: z.ZodOptional; ignoreInvalidURLs: z.ZodOptional; scrapeOptions: z.ZodOptional, z.ZodObject<{ type: z.ZodLiteral<"json">; prompt: z.ZodOptional; schema: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"screenshot">; fullPage: z.ZodOptional; quality: z.ZodOptional; viewport: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"query">; prompt: z.ZodString; }, "strip", z.ZodTypeAny, { type: "query"; prompt: string; }, { type: "query"; prompt: string; }>]>, "many">>; onlyMainContent: z.ZodOptional; includeTags: z.ZodOptional>; excludeTags: z.ZodOptional>; maxAge: z.ZodOptional; headers: z.ZodOptional>; waitFor: z.ZodOptional; mobile: z.ZodOptional; skipTlsVerification: z.ZodOptional; timeout: z.ZodOptional; parsers: z.ZodOptional, z.ZodObject<{ type: z.ZodEnum<["pdf"]>; maxPages: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "pdf"; maxPages?: number | undefined; }, { type: "pdf"; maxPages?: number | undefined; }>]>, "many">>; actions: z.ZodOptional; selector: z.ZodOptional; milliseconds: z.ZodOptional; direction: z.ZodOptional>; text: z.ZodOptional; key: z.ZodOptional; script: z.ZodOptional; fullPage: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }>, "many">>; location: z.ZodOptional; languages: z.ZodOptional>; }, "strip", z.ZodTypeAny, { country?: string | undefined; languages?: string[] | undefined; }, { country?: string | undefined; languages?: string[] | undefined; }>>; removeBase64Images: z.ZodOptional; blockAds: z.ZodOptional; proxy: z.ZodOptional>; storeInCache: z.ZodOptional; }, "strip", z.ZodTypeAny, { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; }, { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; }>>; }, "strip", z.ZodTypeAny, { query: string; country?: string | undefined; location?: string | undefined; timeout?: number | undefined; limit?: number | undefined; tbs?: string | undefined; sources?: { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }[] | undefined; categories?: { type: "pdf" | "github" | "research"; }[] | undefined; ignoreInvalidURLs?: boolean | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; }, { query: string; country?: string | undefined; location?: string | undefined; timeout?: number | undefined; limit?: number | undefined; tbs?: string | undefined; sources?: { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }[] | undefined; categories?: { type: "pdf" | "github" | "research"; }[] | undefined; ignoreInvalidURLs?: boolean | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; }>; declare const mapSchema: z.ZodObject<{ url: z.ZodString; search: z.ZodOptional; limit: z.ZodOptional; includeSubdomains: z.ZodOptional; ignoreQueryParameters: z.ZodOptional; sitemap: z.ZodOptional>; timeout: z.ZodOptional; location: z.ZodOptional; languages: z.ZodOptional>; }, "strip", z.ZodTypeAny, { country?: string | undefined; languages?: string[] | undefined; }, { country?: string | undefined; languages?: string[] | undefined; }>>; }, "strip", z.ZodTypeAny, { url: string; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; timeout?: number | undefined; limit?: number | undefined; search?: string | undefined; includeSubdomains?: boolean | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | "only" | undefined; }, { url: string; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; timeout?: number | undefined; limit?: number | undefined; search?: string | undefined; includeSubdomains?: boolean | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | "only" | undefined; }>; declare const batchScrapeSchema: z.ZodObject<{ urls: z.ZodArray; formats: z.ZodOptional, z.ZodObject<{ type: z.ZodLiteral<"json">; prompt: z.ZodOptional; schema: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"screenshot">; fullPage: z.ZodOptional; quality: z.ZodOptional; viewport: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"query">; prompt: z.ZodString; }, "strip", z.ZodTypeAny, { type: "query"; prompt: string; }, { type: "query"; prompt: string; }>]>, "many">>; parsers: z.ZodOptional, z.ZodObject<{ type: z.ZodEnum<["pdf"]>; maxPages: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "pdf"; maxPages?: number | undefined; }, { type: "pdf"; maxPages?: number | undefined; }>]>, "many">>; onlyMainContent: z.ZodOptional; includeTags: z.ZodOptional>; excludeTags: z.ZodOptional>; waitFor: z.ZodOptional; actions: z.ZodOptional; selector: z.ZodOptional; milliseconds: z.ZodOptional; text: z.ZodOptional; key: z.ZodOptional; direction: z.ZodOptional>; script: z.ZodOptional; fullPage: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }>, "many">>; mobile: z.ZodOptional; skipTlsVerification: z.ZodOptional; removeBase64Images: z.ZodOptional; location: z.ZodOptional; languages: z.ZodOptional>; }, "strip", z.ZodTypeAny, { country?: string | undefined; languages?: string[] | undefined; }, { country?: string | undefined; languages?: string[] | undefined; }>>; storeInCache: z.ZodOptional; maxAge: z.ZodOptional; headers: z.ZodOptional>; blockAds: z.ZodOptional; proxy: z.ZodOptional>; zeroDataRetention: z.ZodOptional; timeout: z.ZodOptional; maxConcurrency: z.ZodOptional; webhook: z.ZodOptional>; metadata: z.ZodOptional>; events: z.ZodOptional, "many">>; }, "strip", z.ZodTypeAny, { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; }, { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; }>>; ignoreInvalidURLs: z.ZodOptional; }, "strip", z.ZodTypeAny, { urls: string[]; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; ignoreInvalidURLs?: boolean | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, { urls: string[]; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; ignoreInvalidURLs?: boolean | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }>; declare const crawlSchema: z.ZodObject<{ url: z.ZodString; limit: z.ZodOptional; maxDiscoveryDepth: z.ZodOptional; allowExternalLinks: z.ZodOptional; allowSubdomains: z.ZodOptional; crawlEntireDomain: z.ZodOptional; includePaths: z.ZodOptional>; excludePaths: z.ZodOptional>; ignoreQueryParameters: z.ZodOptional; sitemap: z.ZodOptional>; prompt: z.ZodOptional; delay: z.ZodOptional; maxConcurrency: z.ZodOptional; scrapeOptions: z.ZodOptional, z.ZodObject<{ type: z.ZodLiteral<"json">; prompt: z.ZodOptional; schema: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }, { type: "json"; prompt?: string | undefined; schema?: Record | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"screenshot">; fullPage: z.ZodOptional; quality: z.ZodOptional; viewport: z.ZodOptional>; }, "strip", z.ZodTypeAny, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }, { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; }>, z.ZodObject<{ type: z.ZodLiteral<"query">; prompt: z.ZodString; }, "strip", z.ZodTypeAny, { type: "query"; prompt: string; }, { type: "query"; prompt: string; }>]>, "many">>; onlyMainContent: z.ZodOptional; includeTags: z.ZodOptional>; excludeTags: z.ZodOptional>; waitFor: z.ZodOptional; maxAge: z.ZodOptional; headers: z.ZodOptional>; mobile: z.ZodOptional; skipTlsVerification: z.ZodOptional; timeout: z.ZodOptional; parsers: z.ZodOptional, z.ZodObject<{ type: z.ZodEnum<["pdf"]>; maxPages: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "pdf"; maxPages?: number | undefined; }, { type: "pdf"; maxPages?: number | undefined; }>]>, "many">>; actions: z.ZodOptional; selector: z.ZodOptional; milliseconds: z.ZodOptional; text: z.ZodOptional; key: z.ZodOptional; direction: z.ZodOptional>; script: z.ZodOptional; fullPage: z.ZodOptional; }, "strip", z.ZodTypeAny, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }, { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }>, "many">>; location: z.ZodOptional; languages: z.ZodOptional>; }, "strip", z.ZodTypeAny, { country?: string | undefined; languages?: string[] | undefined; }, { country?: string | undefined; languages?: string[] | undefined; }>>; removeBase64Images: z.ZodOptional; blockAds: z.ZodOptional; proxy: z.ZodOptional>; storeInCache: z.ZodOptional; }, "strip", z.ZodTypeAny, { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; }, { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; }>>; webhook: z.ZodOptional>; metadata: z.ZodOptional>; events: z.ZodOptional, "many">>; }, "strip", z.ZodTypeAny, { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; }, { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; }>>; zeroDataRetention: z.ZodOptional; }, "strip", z.ZodTypeAny, { url: string; prompt?: string | undefined; zeroDataRetention?: boolean | undefined; limit?: number | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | undefined; maxDiscoveryDepth?: number | undefined; allowExternalLinks?: boolean | undefined; allowSubdomains?: boolean | undefined; crawlEntireDomain?: boolean | undefined; includePaths?: string[] | undefined; excludePaths?: string[] | undefined; delay?: number | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, { url: string; prompt?: string | undefined; zeroDataRetention?: boolean | undefined; limit?: number | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | undefined; maxDiscoveryDepth?: number | undefined; allowExternalLinks?: boolean | undefined; allowSubdomains?: boolean | undefined; crawlEntireDomain?: boolean | undefined; includePaths?: string[] | undefined; excludePaths?: string[] | undefined; delay?: number | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }>; declare const agentSchema: z.ZodObject<{ prompt: z.ZodString; model: z.ZodOptional>; urls: z.ZodOptional>; schema: z.ZodOptional>; maxCredits: z.ZodOptional; }, "strip", z.ZodTypeAny, { prompt: string; schema?: Record | undefined; urls?: string[] | undefined; model?: "spark-1-mini" | "spark-1-pro" | undefined; maxCredits?: number | undefined; }, { prompt: string; schema?: Record | undefined; urls?: string[] | undefined; model?: "spark-1-mini" | "spark-1-pro" | undefined; maxCredits?: number | undefined; }>; declare const checkStatusSchema: z.ZodObject<{ id: z.ZodString; jobType: z.ZodOptional>; }, "strip", z.ZodTypeAny, { id: string; jobType?: "crawl" | "batchScrape" | "agent" | undefined; }, { id: string; jobType?: "crawl" | "batchScrape" | "agent" | undefined; }>; type ScrapeParams = z.infer; type SearchParams = z.infer; type MapParams = z.infer; type AgentParams = z.infer; type BatchScrapeParams = z.infer; type CrawlParams = z.infer; type CheckStatusParams = z.infer; interface ToolOptions { /** Firecrawl API key. Falls back to FIRECRAWL_API_KEY env var. */ apiKey?: string; /** Firecrawl API base URL. Falls back to SERVER_URL env var. */ apiUrl?: string; } type DualTool = ((options?: ToolOptions) => Tool) & Tool; interface InteractOptions extends ToolOptions { /** Existing scrape session id to resume. */ scrapeId?: string; /** Profile to save/reuse browser state across interact sessions. */ profile?: { name: string; saveChanges?: boolean; }; /** Defaults used when bootstrapping the initial scrape session. */ scrape?: Partial>; } type InteractParams = { url?: string; prompt?: string; code?: string; language?: 'node' | 'python' | 'bash'; timeout?: number; }; type InteractTool = Tool & { close(): Promise; start(url: string): Promise; readonly interactiveLiveViewUrl: string | null; readonly liveViewUrl: string | null; readonly scrapeId: string | null; readonly currentUrl: string | null; }; declare const interact: DualTool; declare const agent: DualTool<{ prompt: string; schema?: Record | undefined; urls?: string[] | undefined; model?: "spark-1-mini" | "spark-1-pro" | undefined; maxCredits?: number | undefined; }, { success: boolean; id?: string; error?: string; }>; declare const batchScrape: DualTool<{ urls: string[]; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; ignoreInvalidURLs?: boolean | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, _mendable_firecrawl_js.BatchScrapeJob>; declare const crawl: DualTool<{ url: string; prompt?: string | undefined; zeroDataRetention?: boolean | undefined; limit?: number | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | undefined; maxDiscoveryDepth?: number | undefined; allowExternalLinks?: boolean | undefined; allowSubdomains?: boolean | undefined; crawlEntireDomain?: boolean | undefined; includePaths?: string[] | undefined; excludePaths?: string[] | undefined; delay?: number | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, _mendable_firecrawl_js.CrawlResponse>; declare const poll: ai.Tool<{ jobId: string; jobType: "crawl" | "batchScrape" | "agent"; pollInterval?: number | undefined; maxWaitTime?: number | undefined; }, { success: boolean; status: string; data: _mendable_firecrawl_js.Document[]; total: number; creditsUsed: number | undefined; error?: undefined; } | { success: boolean; status: string; data: unknown; total?: undefined; creditsUsed?: undefined; error?: undefined; } | { success: boolean; status: string; error: string; data?: undefined; total?: undefined; creditsUsed?: undefined; }>; declare const status: ai.Tool<{ id: string; jobType?: "crawl" | "batchScrape" | "agent" | undefined; }, unknown>; declare const cancel: ai.Tool<{ jobId: string; jobType: "crawl" | "batchScrape"; }, { success: boolean; jobId: string; jobType: "crawl" | "batchScrape"; message: string; }>; interface PollOptions { pollInterval?: number; timeout?: number; onProgress?: (status: CrawlJob | BatchScrapeJob | AgentJobStatus) => void; } interface AgentJobStatus { success?: boolean; status: string; error?: string; data?: unknown; } declare function pollCrawlJob(jobId: string, options?: PollOptions): Promise; declare function pollBatchScrapeJob(jobId: string, options?: PollOptions): Promise; declare function pollAgentJob(jobId: string, options?: PollOptions): Promise; /** * Ready-made onStepFinish callbacks for generateText / streamText. * * stepLogger() — accumulates per-tool token stats and timing, call .summary() at the end. * logStep — simple one-liner, no accumulation. * * Usage: * const logger = stepLogger(); * const { text, usage } = await generateText({ * ..., * onStepFinish: logger.onStep, * experimental_onToolCallFinish: logger.onToolCallFinish, * }); * logger.summary(usage); */ type Usage = { inputTokens?: number; outputTokens?: number; totalTokens?: number; }; type StepEvent = { toolCalls?: { toolName: string; input: unknown; toolCallId?: string; }[]; toolResults?: { toolName: string; input?: unknown; output: unknown; toolCallId?: string; }[]; text?: string; usage?: Usage; }; type ToolFinishEvent = { toolCall: { toolCallId?: string; toolName: string; input: unknown; }; durationMs: number; success: boolean; output?: unknown; error?: unknown; }; declare function stepLogger(): { onStep: (e: StepEvent) => void; onToolCallFinish: (event: ToolFinishEvent) => void; close: () => void; summary: (usage?: Usage) => void; }; declare function logStep(e: StepEvent): void; interface BrowserOptions { /** Existing Firecrawl browser session ID. If omitted, a new session is created automatically. */ browserId?: string; /** Firecrawl API key (fc-...). Falls back to FIRECRAWL_API_KEY env var. */ firecrawlApiKey?: string; /** Firecrawl API base URL. Falls back to SERVER_URL env var or https://api.firecrawl.dev. */ firecrawlApiUrl?: string; /** Enable the browser live view for the session. Defaults to true. */ streamWebView?: boolean; /** Profile to save/reuse browser state (cookies, localStorage) across sessions. */ profile?: { name: string; saveChanges?: boolean; }; } type BrowserTool = Tool<{ command: string; }, any> & { close(): Promise; start(): Promise; readonly interactiveLiveViewUrl: string | null; readonly liveViewUrl: string | null; }; /** * @deprecated Use `interact()` instead. * * Create a browser tool that executes agent-browser commands. * * ```ts * import { browser, search } from 'firecrawl-aisdk'; * * const browserTool = browser(); * ``` * * Env: FIRECRAWL_API_KEY for cloud browser sessions. */ declare function browser(options?: BrowserOptions): BrowserTool; interface ToolDescriptionOptions { /** Fully replace the default tool description. */ override?: string; /** Append extra instructions after the default description. */ append?: string; } /** If the option is explicitly `false`, the tool is absent; otherwise present. */ type IfEnabled = [ Option ] extends [false] ? undefined : [ Option ] extends [false | undefined] ? T | undefined : T; type FirecrawlToolsReturn = { search: IfEnabled>; scrape: IfEnabled>; interact: IfEnabled; /** @deprecated Prefer `interact`. */ browser?: IfEnabled; map?: Tool; crawl?: Tool; batchScrape?: Tool; agent?: Tool; poll?: Tool; status?: Tool; cancel?: Tool; /** Auto-generated system prompt guiding the model on tool selection. Pass to `generateText({ system: tools.systemPrompt })`. */ readonly systemPrompt: string; }; interface FirecrawlToolsOptions { /** Firecrawl API key. Falls back to FIRECRAWL_API_KEY env var. */ apiKey?: string; /** Firecrawl API base URL. Falls back to SERVER_URL env var. */ apiUrl?: string; /** Defaults for search, or false to disable. Included by default. */ search?: Partial> | false; /** Defaults for scrape, or false to disable. Included by default. */ scrape?: Partial> | false; /** Defaults for interact, or false to disable. Included by default. */ interact?: InteractOptions | false; /** @deprecated Prefer `interact`. Browser sessions are no longer included by default. */ browser?: BrowserOptions | false; /** Include all tools. When true, enables map, crawl, batchScrape, agent, poll, status, and cancel. */ all?: boolean; /** Include map tool. Set to true or false. Included when `all: true`. */ map?: boolean; /** Include crawl tool. Set to true or false. Included when `all: true`. */ crawl?: boolean; /** Include batchScrape tool. Set to true or false. Included when `all: true`. */ batchScrape?: boolean; /** Include agent tool. Set to true or false. Included when `all: true`. */ agent?: boolean; /** Include poll tool. Auto-included when any async tool is enabled. Set to false to exclude. */ poll?: boolean; /** Include status tool. Set to true or false. Included when `all: true`. */ status?: boolean; /** Include cancel tool. Set to true or false. Included when `all: true`. */ cancel?: boolean; /** Max approximate tokens for tool responses. Truncates output beyond this limit. */ maxResponseTokens?: number; /** Customize tool descriptions sent to the LLM. */ descriptions?: { search?: ToolDescriptionOptions; scrape?: ToolDescriptionOptions; interact?: ToolDescriptionOptions; }; /** Override the auto-generated system prompt. If not set, one is generated based on enabled tools. */ systemPrompt?: string; } /** * Create a tools object for use with generateText/streamText. * * By default includes search, scrape, and interact. * Pass `all: true` to include every tool (map, crawl, batchScrape, agent, poll, status, cancel). * Or opt in individually: `FirecrawlTools({ crawl: true, agent: true })`. * * Poll is auto-included when any async tool (crawl, batchScrape, agent) is enabled. */ declare function FirecrawlTools(options?: O): FirecrawlToolsReturn; /** @deprecated Use `scrape` instead */ declare const scrapeTool: DualTool<{ url: string; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; }, Omit<_mendable_firecrawl_js.Document, "json"> & { json?: unknown; }>; /** @deprecated Use `search` instead */ declare const searchTool: DualTool<{ query: string; country?: string | undefined; location?: string | undefined; timeout?: number | undefined; limit?: number | undefined; tbs?: string | undefined; sources?: { type: "images" | "web" | "news"; location?: string | undefined; tbs?: string | undefined; }[] | undefined; categories?: { type: "pdf" | "github" | "research"; }[] | undefined; ignoreInvalidURLs?: boolean | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; }, _mendable_firecrawl_js.SearchData>; /** @deprecated Use `map` instead */ declare const mapTool: DualTool<{ url: string; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; timeout?: number | undefined; limit?: number | undefined; search?: string | undefined; includeSubdomains?: boolean | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | "only" | undefined; }, _mendable_firecrawl_js.MapData>; /** @deprecated Use `interact` instead */ declare const browserTool: BrowserTool; /** @deprecated Use `crawl` instead */ declare const crawlTool: DualTool<{ url: string; prompt?: string | undefined; zeroDataRetention?: boolean | undefined; limit?: number | undefined; scrapeOptions?: { formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; timeout?: number | undefined; } | undefined; ignoreQueryParameters?: boolean | undefined; sitemap?: "include" | "skip" | undefined; maxDiscoveryDepth?: number | undefined; allowExternalLinks?: boolean | undefined; allowSubdomains?: boolean | undefined; crawlEntireDomain?: boolean | undefined; includePaths?: string[] | undefined; excludePaths?: string[] | undefined; delay?: number | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, _mendable_firecrawl_js.CrawlResponse>; /** @deprecated Use `batchScrape` instead */ declare const batchScrapeTool: DualTool<{ urls: string[]; formats?: ("markdown" | "html" | "rawHtml" | "screenshot" | "links" | "summary" | "changeTracking" | "images" | "branding" | { type: "json"; prompt?: string | undefined; schema?: Record | undefined; } | { type: "screenshot"; fullPage?: boolean | undefined; quality?: number | undefined; viewport?: { width: number; height: number; } | undefined; } | { type: "query"; prompt: string; })[] | undefined; parsers?: ("pdf" | { type: "pdf"; maxPages?: number | undefined; })[] | undefined; onlyMainContent?: boolean | undefined; includeTags?: string[] | undefined; excludeTags?: string[] | undefined; waitFor?: number | undefined; actions?: { type: "screenshot" | "wait" | "scroll" | "scrape" | "click" | "write" | "press" | "executeJavascript" | "generatePDF"; fullPage?: boolean | undefined; selector?: string | undefined; milliseconds?: number | undefined; text?: string | undefined; key?: string | undefined; direction?: "up" | "down" | undefined; script?: string | undefined; }[] | undefined; mobile?: boolean | undefined; skipTlsVerification?: boolean | undefined; removeBase64Images?: boolean | undefined; location?: { country?: string | undefined; languages?: string[] | undefined; } | undefined; storeInCache?: boolean | undefined; maxAge?: number | undefined; headers?: Record | undefined; blockAds?: boolean | undefined; proxy?: "basic" | "stealth" | "auto" | undefined; zeroDataRetention?: boolean | undefined; timeout?: number | undefined; ignoreInvalidURLs?: boolean | undefined; maxConcurrency?: number | undefined; webhook?: { url: string; headers?: Record | undefined; metadata?: Record | undefined; events?: ("completed" | "page" | "failed" | "started")[] | undefined; } | undefined; }, _mendable_firecrawl_js.BatchScrapeJob>; /** @deprecated Use `agent` instead */ declare const agentTool: DualTool<{ prompt: string; schema?: Record | undefined; urls?: string[] | undefined; model?: "spark-1-mini" | "spark-1-pro" | undefined; maxCredits?: number | undefined; }, { success: boolean; id?: string; error?: string; }>; /** @deprecated Use `poll` instead */ declare const pollTool: ai.Tool<{ jobId: string; jobType: "crawl" | "batchScrape" | "agent"; pollInterval?: number | undefined; maxWaitTime?: number | undefined; }, { success: boolean; status: string; data: _mendable_firecrawl_js.Document[]; total: number; creditsUsed: number | undefined; error?: undefined; } | { success: boolean; status: string; data: unknown; total?: undefined; creditsUsed?: undefined; error?: undefined; } | { success: boolean; status: string; error: string; data?: undefined; total?: undefined; creditsUsed?: undefined; }>; /** @deprecated Use `status` instead */ declare const statusTool: ai.Tool<{ id: string; jobType?: "crawl" | "batchScrape" | "agent" | undefined; }, unknown>; /** @deprecated Use `cancel` instead */ declare const cancelTool: ai.Tool<{ jobId: string; jobType: "crawl" | "batchScrape"; }, { success: boolean; jobId: string; jobType: "crawl" | "batchScrape"; message: string; }>; export { type AgentParams, type BatchScrapeParams, type BrowserOptions, type BrowserTool, type CheckStatusParams, type CrawlParams, type DualTool, FirecrawlTools, type FirecrawlToolsOptions, type FirecrawlToolsReturn, type InteractOptions, type InteractTool, type MapParams, type PollOptions, type ScrapeParams, type SearchParams, type ToolOptions, agent, agentSchema, agentTool, batchScrape, batchScrapeSchema, batchScrapeTool, browser, browserTool, cancel, cancelTool, checkStatusSchema, crawl, crawlSchema, crawlTool, interact, interactSchema, logStep, map, mapSchema, mapTool, poll, pollAgentJob, pollBatchScrapeJob, pollCrawlJob, pollTool, scrape, scrapeSchema, scrapeTool, search, searchSchema, searchTool, status, statusTool, stepLogger };