@mendable/firecrawl 1.23.9 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.cts +16 -1
  2. package/dist/index.d.ts +16 -1
  3. package/package.json +1 -1
  4. package/src/index.ts +17 -0
package/dist/index.d.cts CHANGED
@@ -160,6 +160,7 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
160
160
  modes?: ("json" | "git-diff")[];
161
161
  };
162
162
  actions?: ActionsSchema;
163
+ agent?: AgentOptions;
163
164
  }
164
165
  interface ActionsResult {
165
166
  screenshots: string[];
@@ -279,6 +280,19 @@ interface MapResponse {
279
280
  * Parameters for extracting information from URLs.
280
281
  * Defines options for extracting information from URLs.
281
282
  */
283
+ interface AgentOptions {
284
+ model?: string;
285
+ prompt?: string;
286
+ sessionId?: string;
287
+ }
288
+ /**
289
+ * Parameters for extracting information from URLs.
290
+ * Defines options for extracting information from URLs.
291
+ */
292
+ interface AgentOptionsExtract {
293
+ model?: string;
294
+ sessionId?: string;
295
+ }
282
296
  interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
283
297
  prompt?: string;
284
298
  schema?: LLMSchema | object;
@@ -289,6 +303,7 @@ interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
289
303
  origin?: string;
290
304
  showSources?: boolean;
291
305
  scrapeOptions?: CrawlScrapeOptions;
306
+ agent?: AgentOptionsExtract;
292
307
  }
293
308
  /**
294
309
  * Response interface for extracting information from URLs.
@@ -765,4 +780,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
765
780
  close(): void;
766
781
  }
767
782
 
768
- 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 };
783
+ export { type Action, type ActionsResult, type AgentOptions, type AgentOptionsExtract, 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 CHANGED
@@ -160,6 +160,7 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
160
160
  modes?: ("json" | "git-diff")[];
161
161
  };
162
162
  actions?: ActionsSchema;
163
+ agent?: AgentOptions;
163
164
  }
164
165
  interface ActionsResult {
165
166
  screenshots: string[];
@@ -279,6 +280,19 @@ interface MapResponse {
279
280
  * Parameters for extracting information from URLs.
280
281
  * Defines options for extracting information from URLs.
281
282
  */
283
+ interface AgentOptions {
284
+ model?: string;
285
+ prompt?: string;
286
+ sessionId?: string;
287
+ }
288
+ /**
289
+ * Parameters for extracting information from URLs.
290
+ * Defines options for extracting information from URLs.
291
+ */
292
+ interface AgentOptionsExtract {
293
+ model?: string;
294
+ sessionId?: string;
295
+ }
282
296
  interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
283
297
  prompt?: string;
284
298
  schema?: LLMSchema | object;
@@ -289,6 +303,7 @@ interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
289
303
  origin?: string;
290
304
  showSources?: boolean;
291
305
  scrapeOptions?: CrawlScrapeOptions;
306
+ agent?: AgentOptionsExtract;
292
307
  }
293
308
  /**
294
309
  * Response interface for extracting information from URLs.
@@ -765,4 +780,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
765
780
  close(): void;
766
781
  }
767
782
 
768
- 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 };
783
+ export { type Action, type ActionsResult, type AgentOptions, type AgentOptionsExtract, 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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mendable/firecrawl",
3
- "version": "1.23.9",
3
+ "version": "1.24.0",
4
4
  "description": "JavaScript SDK for Firecrawl API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/index.ts CHANGED
@@ -167,6 +167,7 @@ export interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchem
167
167
  modes?: ("json" | "git-diff")[];
168
168
  }
169
169
  actions?: ActionsSchema;
170
+ agent?: AgentOptions;
170
171
  }
171
172
 
172
173
  export interface ActionsResult {
@@ -296,6 +297,21 @@ export interface MapResponse {
296
297
  * Parameters for extracting information from URLs.
297
298
  * Defines options for extracting information from URLs.
298
299
  */
300
+ export interface AgentOptions {
301
+ model?: string;
302
+ prompt?: string;
303
+ sessionId?: string;
304
+ }
305
+
306
+ /**
307
+ * Parameters for extracting information from URLs.
308
+ * Defines options for extracting information from URLs.
309
+ */
310
+ export interface AgentOptionsExtract {
311
+ model?: string;
312
+ sessionId?: string;
313
+ }
314
+
299
315
  export interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
300
316
  prompt?: string;
301
317
  schema?: LLMSchema | object;
@@ -306,6 +322,7 @@ export interface ExtractParams<LLMSchema extends zt.ZodSchema = any> {
306
322
  origin?: string;
307
323
  showSources?: boolean;
308
324
  scrapeOptions?: CrawlScrapeOptions;
325
+ agent?: AgentOptionsExtract;
309
326
  }
310
327
 
311
328
  /**