@mendable/firecrawl 1.18.1 → 1.18.6

package/dist/index.d.cts

@@ -61,6 +61,7 @@ interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | neve
     rawHtml?: string;
     links?: string[];
     extract?: T;
+    json?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
     actions: ActionsSchema;
@@ -72,7 +73,7 @@ interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | neve
  * Defines the options and configurations available for scraping web content.
  */
 interface CrawlScrapeOptions {
-    formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract")[];
+    formats?: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract" | "json")[];
     headers?: Record<string, string>;
     includeTags?: string[];
     excludeTags?: string[];
@@ -86,6 +87,8 @@ interface CrawlScrapeOptions {
     mobile?: boolean;
     skipTlsVerification?: boolean;
     removeBase64Images?: boolean;
+    blockAds?: boolean;
+    proxy?: "basic" | "stealth";
 }
 type Action = {
     type: "wait";
@@ -119,6 +122,11 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
         schema?: LLMSchema;
         systemPrompt?: string;
     };
+    jsonOptions?: {
+        prompt?: string;
+        schema?: LLMSchema;
+        systemPrompt?: string;
+    };
     actions?: ActionsSchema;
 }
 interface ActionsResult {
@@ -150,6 +158,7 @@ interface CrawlParams {
         url: string;
         headers?: Record<string, string>;
         metadata?: Record<string, string>;
+        events?: ["completed", "failed", "page", "started"][number][];
     };
     deduplicateSimilarURLs?: boolean;
     ignoreQueryParameters?: boolean;
@@ -213,6 +222,7 @@ interface MapParams {
     includeSubdomains?: boolean;
     sitemapOnly?: boolean;
     limit?: number;
+    timeout?: number;
 }
 /**
  * Response interface for mapping operations.
@@ -232,7 +242,11 @@ interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
     schema?: LLMSchema | object;
     systemPrompt?: string;
     allowExternalLinks?: boolean;
+    enableWebSearch?: boolean;
     includeSubdomains?: boolean;
+    origin?: string;
+    showSources?: boolean;
+    scrapeOptions?: CrawlScrapeOptions;
 }
 /**
  * Response interface for extracting information from URLs.
@@ -243,6 +257,7 @@ interface ExtractResponse<LLMSchema extends zt.ZodSchema = any> {
     data: LLMSchema;
     error?: string;
     warning?: string;
+    sources?: string[];
 }
 /**
  * Error response interface.
@@ -258,7 +273,8 @@ interface ErrorResponse {
  */
 declare class FirecrawlError extends Error {
     statusCode: number;
-    constructor(message: string, statusCode: number);
+    details?: any;
+    constructor(message: string, statusCode: number, details?: any);
 }
 /**
  * Parameters for search operations.
@@ -285,6 +301,129 @@ interface SearchResponse {
     warning?: string;
     error?: string;
 }
+/**
+ * Response interface for crawl/batch scrape error monitoring.
+ */
+interface CrawlErrorsResponse {
+    /**
+     * Scrapes that errored out + error details
+     */
+    errors: {
+        id: string;
+        timestamp?: string;
+        url: string;
+        error: string;
+    }[];
+    /**
+     * URLs blocked by robots.txt
+     */
+    robotsBlocked: string[];
+}
+/**
+ * Parameters for deep research operations.
+ * Defines options for conducting deep research on a topic.
+ */
+interface DeepResearchParams {
+    /**
+     * Maximum depth of research iterations (1-10)
+     * @default 7
+     */
+    maxDepth?: number;
+    /**
+     * Time limit in seconds (30-300)
+     * @default 270
+     */
+    timeLimit?: number;
+    /**
+     * Maximum number of URLs to analyze (1-1000)
+     * @default 20
+     */
+    maxUrls?: number;
+    /**
+     * Experimental flag for streaming steps
+     */
+    __experimental_streamSteps?: boolean;
+}
+/**
+ * Response interface for deep research operations.
+ */
+interface DeepResearchResponse {
+    success: boolean;
+    id: string;
+}
+/**
+ * Status response interface for deep research operations.
+ */
+interface DeepResearchStatusResponse {
+    success: boolean;
+    data: {
+        findings: Array<{
+            text: string;
+            source: string;
+        }>;
+        finalAnalysis: string;
+        analysis: string;
+        completedSteps: number;
+        totalSteps: number;
+    };
+    status: "processing" | "completed" | "failed";
+    error?: string;
+    expiresAt: string;
+    currentDepth: number;
+    maxDepth: number;
+    activities: Array<{
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }>;
+    sources: Array<{
+        url: string;
+        title: string;
+        description: string;
+    }>;
+    summaries: string[];
+}
+/**
+ * Parameters for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextParams {
+    /**
+     * Maximum number of URLs to process (1-100)
+     * @default 10
+     */
+    maxUrls?: number;
+    /**
+     * Whether to show the full LLMs-full.txt in the response
+     * @default false
+     */
+    showFullText?: boolean;
+    /**
+     * Experimental flag for streaming
+     */
+    __experimental_stream?: boolean;
+}
+/**
+ * Response interface for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextResponse {
+    success: boolean;
+    id: string;
+}
+/**
+ * Status response interface for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextStatusResponse {
+    success: boolean;
+    data: {
+        llmstxt: string;
+        llmsfulltxt?: string;
+    };
+    status: "processing" | "completed" | "failed";
+    error?: string;
+    expiresAt: string;
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -326,9 +465,18 @@ declare class FirecrawlApp {
      * Checks the status of a crawl job using the Firecrawl API.
      * @param id - The ID of the crawl operation.
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
+     * @param nextURL - The `next` URL from the previous crawl status. Only required if you're not manually increasing `skip`. Only used when `getAllData = false`.
+     * @param skip - How many entries to skip to paginate. Only required if you're not providing `nextURL`. Only used when `getAllData = false`.
+     * @param limit - How many entries to return. Only used when `getAllData = false`.
      * @returns The response containing the job status.
      */
-    checkCrawlStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    checkCrawlStatus(id?: string, getAllData?: boolean, nextURL?: string, skip?: number, limit?: number): Promise<CrawlStatusResponse | ErrorResponse>;
+    /**
+     * Returns information about crawl errors.
+     * @param id - The ID of the crawl operation.
+     * @returns Information about crawl errors.
+     */
+    checkCrawlErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
     /**
      * Cancels a crawl job using the Firecrawl API.
      * @param id - The ID of the crawl operation.
@@ -373,9 +521,18 @@ declare class FirecrawlApp {
      * Checks the status of a batch scrape job using the Firecrawl API.
      * @param id - The ID of the batch scrape operation.
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
+     * @param nextURL - The `next` URL from the previous batch scrape status. Only required if you're not manually increasing `skip`. Only used when `getAllData = false`.
+     * @param skip - How many entries to skip to paginate. Only used when `getAllData = false`.
+     * @param limit - How many entries to return. Only used when `getAllData = false`.
      * @returns The response containing the job status.
      */
-    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    checkBatchScrapeStatus(id?: string, getAllData?: boolean, nextURL?: string, skip?: number, limit?: number): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    /**
+     * Returns information about batch scrape errors.
+     * @param id - The ID of the batch scrape operation.
+     * @returns Information about batch scrape errors.
+     */
+    checkBatchScrapeErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
     /**
      * Extracts information from URLs using the Firecrawl API.
      * Currently in Beta. Expect breaking changes on future minor versions.
@@ -384,6 +541,20 @@ declare class FirecrawlApp {
      * @returns The response from the extract operation.
      */
     extract<T extends zt.ZodSchema = any>(urls: string[], params?: ExtractParams<T>): Promise<ExtractResponse<zt.infer<T>> | ErrorResponse>;
+    /**
+     * Initiates an asynchronous extract job for a URL using the Firecrawl API.
+     * @param url - The URL to extract data from.
+     * @param params - Additional parameters for the extract request.
+     * @param idempotencyKey - Optional idempotency key for the request.
+     * @returns The response from the extract operation.
+     */
+    asyncExtract(urls: string[], params?: ExtractParams, idempotencyKey?: string): Promise<ExtractResponse | ErrorResponse>;
+    /**
+     * Retrieves the status of an extract job.
+     * @param jobId - The ID of the extract job.
+     * @returns The status of the extract job.
+     */
+    getExtractStatus(jobId: string): Promise<any>;
     /**
      * Prepares the headers for an API request.
      * @param idempotencyKey - Optional key to ensure idempotency.
@@ -427,6 +598,52 @@ declare class FirecrawlApp {
      * @param {string} action - The action being performed when the error occurred.
      */
     handleError(response: AxiosResponse, action: string): void;
+    /**
+     * Initiates a deep research operation on a given topic and polls until completion.
+     * @param topic - The topic to research.
+     * @param params - Parameters for the deep research operation.
+     * @param onActivity - Optional callback to receive activity updates in real-time.
+     * @returns The final research results.
+     */
+    __deepResearch(topic: string, params: DeepResearchParams, onActivity?: (activity: {
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }) => void): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a deep research operation on a given topic without polling.
+     * @param params - Parameters for the deep research operation.
+     * @returns The response containing the research job ID.
+     */
+    __asyncDeepResearch(topic: string, params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
+    /**
+     * Checks the status of a deep research operation.
+     * @param id - The ID of the deep research operation.
+     * @returns The current status and results of the research operation.
+     */
+    __checkDeepResearchStatus(id: string): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Generates LLMs.txt for a given URL and polls until completion.
+     * @param url - The URL to generate LLMs.txt from.
+     * @param params - Parameters for the LLMs.txt generation operation.
+     * @returns The final generation results.
+     */
+    generateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a LLMs.txt generation operation without polling.
+     * @param url - The URL to generate LLMs.txt from.
+     * @param params - Parameters for the LLMs.txt generation operation.
+     * @returns The response containing the generation job ID.
+     */
+    asyncGenerateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextResponse | ErrorResponse>;
+    /**
+     * Checks the status of a LLMs.txt generation operation.
+     * @param id - The ID of the LLMs.txt generation operation.
+     * @returns The current status and results of the generation operation.
+     */
+    checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
 }
 interface CrawlWatcherEvents {
     document: CustomEvent<FirecrawlDocument<undefined>>;
@@ -449,4 +666,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type ExtractParams, type ExtractResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, type SearchParams, type SearchResponse, FirecrawlApp as default };
+export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlErrorsResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type DeepResearchParams, type DeepResearchResponse, type DeepResearchStatusResponse, type ErrorResponse, type ExtractParams, type ExtractResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type GenerateLLMsTextParams, type GenerateLLMsTextResponse, type GenerateLLMsTextStatusResponse, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, type SearchParams, type SearchResponse, FirecrawlApp as default };

package/dist/index.d.ts

@@ -61,6 +61,7 @@ interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | neve
     rawHtml?: string;
     links?: string[];
     extract?: T;
+    json?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
     actions: ActionsSchema;
@@ -72,7 +73,7 @@ interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | neve
  * Defines the options and configurations available for scraping web content.
  */
 interface CrawlScrapeOptions {
-    formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract")[];
+    formats?: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract" | "json")[];
     headers?: Record<string, string>;
     includeTags?: string[];
     excludeTags?: string[];
@@ -86,6 +87,8 @@ interface CrawlScrapeOptions {
     mobile?: boolean;
     skipTlsVerification?: boolean;
     removeBase64Images?: boolean;
+    blockAds?: boolean;
+    proxy?: "basic" | "stealth";
 }
 type Action = {
     type: "wait";
@@ -119,6 +122,11 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
         schema?: LLMSchema;
         systemPrompt?: string;
     };
+    jsonOptions?: {
+        prompt?: string;
+        schema?: LLMSchema;
+        systemPrompt?: string;
+    };
     actions?: ActionsSchema;
 }
 interface ActionsResult {
@@ -150,6 +158,7 @@ interface CrawlParams {
         url: string;
         headers?: Record<string, string>;
         metadata?: Record<string, string>;
+        events?: ["completed", "failed", "page", "started"][number][];
     };
     deduplicateSimilarURLs?: boolean;
     ignoreQueryParameters?: boolean;
@@ -213,6 +222,7 @@ interface MapParams {
     includeSubdomains?: boolean;
     sitemapOnly?: boolean;
     limit?: number;
+    timeout?: number;
 }
 /**
  * Response interface for mapping operations.
@@ -232,7 +242,11 @@ interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
     schema?: LLMSchema | object;
     systemPrompt?: string;
     allowExternalLinks?: boolean;
+    enableWebSearch?: boolean;
     includeSubdomains?: boolean;
+    origin?: string;
+    showSources?: boolean;
+    scrapeOptions?: CrawlScrapeOptions;
 }
 /**
  * Response interface for extracting information from URLs.
@@ -243,6 +257,7 @@ interface ExtractResponse<LLMSchema extends zt.ZodSchema = any> {
     data: LLMSchema;
     error?: string;
     warning?: string;
+    sources?: string[];
 }
 /**
  * Error response interface.
@@ -258,7 +273,8 @@ interface ErrorResponse {
  */
 declare class FirecrawlError extends Error {
     statusCode: number;
-    constructor(message: string, statusCode: number);
+    details?: any;
+    constructor(message: string, statusCode: number, details?: any);
 }
 /**
  * Parameters for search operations.
@@ -285,6 +301,129 @@ interface SearchResponse {
     warning?: string;
     error?: string;
 }
+/**
+ * Response interface for crawl/batch scrape error monitoring.
+ */
+interface CrawlErrorsResponse {
+    /**
+     * Scrapes that errored out + error details
+     */
+    errors: {
+        id: string;
+        timestamp?: string;
+        url: string;
+        error: string;
+    }[];
+    /**
+     * URLs blocked by robots.txt
+     */
+    robotsBlocked: string[];
+}
+/**
+ * Parameters for deep research operations.
+ * Defines options for conducting deep research on a topic.
+ */
+interface DeepResearchParams {
+    /**
+     * Maximum depth of research iterations (1-10)
+     * @default 7
+     */
+    maxDepth?: number;
+    /**
+     * Time limit in seconds (30-300)
+     * @default 270
+     */
+    timeLimit?: number;
+    /**
+     * Maximum number of URLs to analyze (1-1000)
+     * @default 20
+     */
+    maxUrls?: number;
+    /**
+     * Experimental flag for streaming steps
+     */
+    __experimental_streamSteps?: boolean;
+}
+/**
+ * Response interface for deep research operations.
+ */
+interface DeepResearchResponse {
+    success: boolean;
+    id: string;
+}
+/**
+ * Status response interface for deep research operations.
+ */
+interface DeepResearchStatusResponse {
+    success: boolean;
+    data: {
+        findings: Array<{
+            text: string;
+            source: string;
+        }>;
+        finalAnalysis: string;
+        analysis: string;
+        completedSteps: number;
+        totalSteps: number;
+    };
+    status: "processing" | "completed" | "failed";
+    error?: string;
+    expiresAt: string;
+    currentDepth: number;
+    maxDepth: number;
+    activities: Array<{
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }>;
+    sources: Array<{
+        url: string;
+        title: string;
+        description: string;
+    }>;
+    summaries: string[];
+}
+/**
+ * Parameters for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextParams {
+    /**
+     * Maximum number of URLs to process (1-100)
+     * @default 10
+     */
+    maxUrls?: number;
+    /**
+     * Whether to show the full LLMs-full.txt in the response
+     * @default false
+     */
+    showFullText?: boolean;
+    /**
+     * Experimental flag for streaming
+     */
+    __experimental_stream?: boolean;
+}
+/**
+ * Response interface for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextResponse {
+    success: boolean;
+    id: string;
+}
+/**
+ * Status response interface for LLMs.txt generation operations.
+ */
+interface GenerateLLMsTextStatusResponse {
+    success: boolean;
+    data: {
+        llmstxt: string;
+        llmsfulltxt?: string;
+    };
+    status: "processing" | "completed" | "failed";
+    error?: string;
+    expiresAt: string;
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -326,9 +465,18 @@ declare class FirecrawlApp {
      * Checks the status of a crawl job using the Firecrawl API.
      * @param id - The ID of the crawl operation.
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
+     * @param nextURL - The `next` URL from the previous crawl status. Only required if you're not manually increasing `skip`. Only used when `getAllData = false`.
+     * @param skip - How many entries to skip to paginate. Only required if you're not providing `nextURL`. Only used when `getAllData = false`.
+     * @param limit - How many entries to return. Only used when `getAllData = false`.
      * @returns The response containing the job status.
      */
-    checkCrawlStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    checkCrawlStatus(id?: string, getAllData?: boolean, nextURL?: string, skip?: number, limit?: number): Promise<CrawlStatusResponse | ErrorResponse>;
+    /**
+     * Returns information about crawl errors.
+     * @param id - The ID of the crawl operation.
+     * @returns Information about crawl errors.
+     */
+    checkCrawlErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
     /**
      * Cancels a crawl job using the Firecrawl API.
      * @param id - The ID of the crawl operation.
@@ -373,9 +521,18 @@ declare class FirecrawlApp {
      * Checks the status of a batch scrape job using the Firecrawl API.
      * @param id - The ID of the batch scrape operation.
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
+     * @param nextURL - The `next` URL from the previous batch scrape status. Only required if you're not manually increasing `skip`. Only used when `getAllData = false`.
+     * @param skip - How many entries to skip to paginate. Only used when `getAllData = false`.
+     * @param limit - How many entries to return. Only used when `getAllData = false`.
      * @returns The response containing the job status.
      */
-    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    checkBatchScrapeStatus(id?: string, getAllData?: boolean, nextURL?: string, skip?: number, limit?: number): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    /**
+     * Returns information about batch scrape errors.
+     * @param id - The ID of the batch scrape operation.
+     * @returns Information about batch scrape errors.
+     */
+    checkBatchScrapeErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
     /**
      * Extracts information from URLs using the Firecrawl API.
      * Currently in Beta. Expect breaking changes on future minor versions.
@@ -384,6 +541,20 @@ declare class FirecrawlApp {
      * @returns The response from the extract operation.
      */
     extract<T extends zt.ZodSchema = any>(urls: string[], params?: ExtractParams<T>): Promise<ExtractResponse<zt.infer<T>> | ErrorResponse>;
+    /**
+     * Initiates an asynchronous extract job for a URL using the Firecrawl API.
+     * @param url - The URL to extract data from.
+     * @param params - Additional parameters for the extract request.
+     * @param idempotencyKey - Optional idempotency key for the request.
+     * @returns The response from the extract operation.
+     */
+    asyncExtract(urls: string[], params?: ExtractParams, idempotencyKey?: string): Promise<ExtractResponse | ErrorResponse>;
+    /**
+     * Retrieves the status of an extract job.
+     * @param jobId - The ID of the extract job.
+     * @returns The status of the extract job.
+     */
+    getExtractStatus(jobId: string): Promise<any>;
     /**
      * Prepares the headers for an API request.
      * @param idempotencyKey - Optional key to ensure idempotency.
@@ -427,6 +598,52 @@ declare class FirecrawlApp {
      * @param {string} action - The action being performed when the error occurred.
      */
     handleError(response: AxiosResponse, action: string): void;
+    /**
+     * Initiates a deep research operation on a given topic and polls until completion.
+     * @param topic - The topic to research.
+     * @param params - Parameters for the deep research operation.
+     * @param onActivity - Optional callback to receive activity updates in real-time.
+     * @returns The final research results.
+     */
+    __deepResearch(topic: string, params: DeepResearchParams, onActivity?: (activity: {
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }) => void): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a deep research operation on a given topic without polling.
+     * @param params - Parameters for the deep research operation.
+     * @returns The response containing the research job ID.
+     */
+    __asyncDeepResearch(topic: string, params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
+    /**
+     * Checks the status of a deep research operation.
+     * @param id - The ID of the deep research operation.
+     * @returns The current status and results of the research operation.
+     */
+    __checkDeepResearchStatus(id: string): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Generates LLMs.txt for a given URL and polls until completion.
+     * @param url - The URL to generate LLMs.txt from.
+     * @param params - Parameters for the LLMs.txt generation operation.
+     * @returns The final generation results.
+     */
+    generateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a LLMs.txt generation operation without polling.
+     * @param url - The URL to generate LLMs.txt from.
+     * @param params - Parameters for the LLMs.txt generation operation.
+     * @returns The response containing the generation job ID.
+     */
+    asyncGenerateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextResponse | ErrorResponse>;
+    /**
+     * Checks the status of a LLMs.txt generation operation.
+     * @param id - The ID of the LLMs.txt generation operation.
+     * @returns The current status and results of the generation operation.
+     */
+    checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
 }
 interface CrawlWatcherEvents {
     document: CustomEvent<FirecrawlDocument<undefined>>;
@@ -449,4 +666,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type ExtractParams, type ExtractResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, type SearchParams, type SearchResponse, FirecrawlApp as default };
+export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlErrorsResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type DeepResearchParams, type DeepResearchResponse, type DeepResearchStatusResponse, type ErrorResponse, type ExtractParams, type ExtractResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type GenerateLLMsTextParams, type GenerateLLMsTextResponse, type GenerateLLMsTextStatusResponse, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, type SearchParams, type SearchResponse, FirecrawlApp as default };