firecrawl 1.25.5 → 1.26.0

package/dist/index.cjs

@@ -34,8 +34,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
-      name: "@mendable/firecrawl-js",
-      version: "1.25.5",
+      name: "firecrawl",
+      version: "1.26.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -516,9 +516,9 @@ var FirecrawlApp = class {
    * @param ignoreInvalidURLs - Optional flag to ignore invalid URLs.
    * @returns The response from the crawl operation.
    */
-  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook, ignoreInvalidURLs) {
+  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook, ignoreInvalidURLs, maxConcurrency) {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData = { urls, webhook, ignoreInvalidURLs, ...params, origin: `js-sdk@${this.version}` };
+    let jsonData = { urls, webhook, ignoreInvalidURLs, maxConcurrency, ...params, origin: `js-sdk@${this.version}` };
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {

package/dist/index.d.cts

@@ -199,6 +199,7 @@ interface CrawlParams {
     maxDiscoveryDepth?: number;
     limit?: number;
     allowBackwardLinks?: boolean;
+    crawlEntireDomain?: boolean;
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
     scrapeOptions?: CrawlScrapeOptions;
@@ -216,6 +217,7 @@ interface CrawlParams {
      * If not provided, the crawler may use the robots.txt crawl delay if available.
      */
     delay?: number;
+    maxConcurrency?: number;
 }
 /**
  * Response interface for crawling operations.
@@ -606,7 +608,7 @@ declare class FirecrawlApp {
      * @param ignoreInvalidURLs - Optional flag to ignore invalid URLs.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean, maxConcurrency?: number): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.

package/dist/index.d.ts

@@ -199,6 +199,7 @@ interface CrawlParams {
     maxDiscoveryDepth?: number;
     limit?: number;
     allowBackwardLinks?: boolean;
+    crawlEntireDomain?: boolean;
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
     scrapeOptions?: CrawlScrapeOptions;
@@ -216,6 +217,7 @@ interface CrawlParams {
      * If not provided, the crawler may use the robots.txt crawl delay if available.
      */
     delay?: number;
+    maxConcurrency?: number;
 }
 /**
  * Response interface for crawling operations.
@@ -606,7 +608,7 @@ declare class FirecrawlApp {
      * @param ignoreInvalidURLs - Optional flag to ignore invalid URLs.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean, maxConcurrency?: number): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string, webhook?: CrawlParams["webhook"], ignoreInvalidURLs?: boolean): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.

package/dist/index.js

@@ -29,7 +29,7 @@ var FirecrawlApp = class {
   }
   async getVersion() {
     try {
-      const packageJson = await import("./package-FAEOWTCQ.js");
+      const packageJson = await import("./package-6BJUVGSJ.js");
       return packageJson.default.version;
     } catch (error) {
       console.error("Error getting version:", error);
@@ -407,9 +407,9 @@ var FirecrawlApp = class {
    * @param ignoreInvalidURLs - Optional flag to ignore invalid URLs.
    * @returns The response from the crawl operation.
    */
-  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook, ignoreInvalidURLs) {
+  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook, ignoreInvalidURLs, maxConcurrency) {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData = { urls, webhook, ignoreInvalidURLs, ...params, origin: `js-sdk@${this.version}` };
+    let jsonData = { urls, webhook, ignoreInvalidURLs, maxConcurrency, ...params, origin: `js-sdk@${this.version}` };
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
       try {

package/dist/{package-FAEOWTCQ.js → package-6BJUVGSJ.js}

@@ -1,6 +1,6 @@
 // package.json
-var name = "@mendable/firecrawl-js";
-var version = "1.25.5";
+var name = "firecrawl";
+var version = "1.26.0";
 var description = "JavaScript SDK for Firecrawl API";
 var main = "dist/index.js";
 var types = "dist/index.d.ts";

package/package.json

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

package/src/__tests__/v1/e2e_withAuth/index.test.ts

@@ -26,7 +26,7 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should throw error for invalid API key on scrape', async () => {
     if (API_URL.includes('api.firecrawl.dev')) {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
-      await expect(invalidApp.scrapeUrl('https://roastmywebsite.ai')).rejects.toThrow("Unexpected error occurred while trying to scrape URL. Status code: 404");
+      await expect(invalidApp.scrapeUrl('https://roastmywebsite.ai')).rejects.toThrow("Unexpected error occurred while trying to scrape URL. Status code: 401");
     } else {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
       await expect(invalidApp.scrapeUrl('https://roastmywebsite.ai')).resolves.not.toThrow();
@@ -36,36 +36,16 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should throw error for blocklisted URL on scrape', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const blocklistedUrl = "https://facebook.com/fake-test";
-    await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow("Request failed with status code 403");
+    await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow("This website is no longer supported");
   });
 
-  test.concurrent('should return successful response with valid preview token', async () => {
-    const app = new FirecrawlApp({ apiKey: process.env.PREVIEW_TOKEN, apiUrl: API_URL });
-    const response = await app.scrapeUrl('https://roastmywebsite.ai');
-    if (!response.success) {
-      throw new Error(response.error);
-    }
-
-    expect(response).not.toBeNull();
-    expect(response?.markdown).toContain("_Roast_");
-  }, 30000); // 30 seconds timeout
-
   test.concurrent('should return successful response for valid scrape', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+
     const response = await app.scrapeUrl('https://roastmywebsite.ai');
     if (!response.success) {
       throw new Error(response.error);
     }
-
-    expect(response).not.toBeNull();
-    expect(response).not.toHaveProperty('content'); // v0
-    expect(response).not.toHaveProperty('html');
-    expect(response).not.toHaveProperty('rawHtml');
-    expect(response).not.toHaveProperty('screenshot');
-    expect(response).not.toHaveProperty('links');
-
-    expect(response).toHaveProperty('markdown');
-    expect(response).toHaveProperty('metadata');
   }, 30000); // 30 seconds timeout
 
   test.concurrent('should return successful response with valid API key and options', async () => {
@@ -80,53 +60,10 @@ describe('FirecrawlApp E2E Tests', () => {
         timeout: 30000,
         waitFor: 1000
     });
+
     if (!response.success) {
       throw new Error(response.error);
     }
-
-    expect(response).not.toBeNull();
-    expect(response).not.toHaveProperty('content'); // v0
-    expect(response.markdown).toContain("_Roast_");
-    expect(response.html).toContain("<h1");
-    expect(response.rawHtml).toContain("<h1");
-    expect(response.screenshot).not.toBeUndefined();
-    expect(response.screenshot).not.toBeNull();
-    expect(response.screenshot).toContain("https://");
-    expect(response.links).not.toBeNull();
-    expect(response.links?.length).toBeGreaterThan(0);
-    expect(response.links?.[0]).toContain("https://");
-    expect(response.metadata).not.toBeNull();
-    expect(response.metadata).not.toBeUndefined();
-    expect(response.metadata).toHaveProperty("title");
-    expect(response.metadata).toHaveProperty("description");
-    expect(response.metadata).toHaveProperty("keywords");
-    expect(response.metadata).toHaveProperty("robots");
-    expect(response.metadata).toHaveProperty("ogTitle");
-    expect(response.metadata).toHaveProperty("ogDescription");
-    expect(response.metadata).toHaveProperty("ogUrl");
-    expect(response.metadata).toHaveProperty("ogImage");
-    expect(response.metadata).toHaveProperty("ogLocaleAlternate");
-    expect(response.metadata).toHaveProperty("ogSiteName");
-    expect(response.metadata).toHaveProperty("sourceURL");
-    expect(response.metadata).not.toHaveProperty("pageStatusCode");
-    expect(response.metadata).toHaveProperty("statusCode");
-    expect(response.metadata).not.toHaveProperty("pageError");
-
-    if (response.metadata !== undefined) {
-      expect(response.metadata.error).toBeUndefined();
-      expect(response.metadata.title).toBe("Roast My Website");
-      expect(response.metadata.description).toBe("Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️");
-      expect(response.metadata.keywords).toBe("Roast My Website,Roast,Website,GitHub,Firecrawl");
-      expect(response.metadata.robots).toBe("follow, index");
-      expect(response.metadata.ogTitle).toBe("Roast My Website");
-      expect(response.metadata.ogDescription).toBe("Welcome to Roast My Website, the ultimate tool for putting your website through the wringer! This repository harnesses the power of Firecrawl to scrape and capture screenshots of websites, and then unleashes the latest LLM vision models to mercilessly roast them. 🌶️");
-      expect(response.metadata.ogUrl).toBe("https://www.roastmywebsite.ai");
-      expect(response.metadata.ogImage).toBe("https://www.roastmywebsite.ai/og.png");
-      expect(response.metadata.ogLocaleAlternate).toStrictEqual([]);
-      expect(response.metadata.ogSiteName).toBe("Roast My Website");
-      expect(response.metadata.sourceURL).toBe("https://roastmywebsite.ai");
-      expect(response.metadata.statusCode).toBe(200);
-    }
   }, 30000); // 30 seconds timeout
 
   test.concurrent('should return successful response with valid API key and screenshot fullPage', async () => {
@@ -139,7 +76,6 @@ describe('FirecrawlApp E2E Tests', () => {
       throw new Error(response.error);
     }
 
-    expect(response).not.toBeNull();
     expect(response.screenshot).not.toBeUndefined();
     expect(response.screenshot).not.toBeNull();
     expect(response.screenshot).toContain("https://");
@@ -170,7 +106,7 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should throw error for invalid API key on crawl', async () => {
     if (API_URL.includes('api.firecrawl.dev')) {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
-      await expect(invalidApp.crawlUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 404");
+      await expect(invalidApp.crawlUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 401");
     } else {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
       await expect(invalidApp.crawlUrl('https://roastmywebsite.ai')).resolves.not.toThrow();
@@ -180,34 +116,10 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should return successful response for crawl and wait for completion', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const response = await app.crawlUrl('https://roastmywebsite.ai', {}, 30) as CrawlStatusResponse;
-    expect(response).not.toBeNull();
-    expect(response).toHaveProperty("total");
-    expect(response.total).toBeGreaterThan(0);
-    expect(response).toHaveProperty("creditsUsed");
-    expect(response.creditsUsed).toBeGreaterThan(0);
-    expect(response).toHaveProperty("expiresAt");
-    expect(new Date(response.expiresAt).getTime()).toBeGreaterThan(Date.now());
-    expect(response).toHaveProperty("status");
-    expect(response.status).toBe("completed");
     expect(response).not.toHaveProperty("next"); // wait until done
     expect(response.data.length).toBeGreaterThan(0);
-    expect(response.data[0]).not.toBeNull();
-    expect(response.data[0]).not.toBeUndefined();
     if (response.data[0]) {
       expect(response.data[0]).toHaveProperty("markdown");
-      expect(response.data[0].markdown).toContain("_Roast_");
-      expect(response.data[0]).not.toHaveProperty('content'); // v0
-      expect(response.data[0]).not.toHaveProperty("html");
-      expect(response.data[0]).not.toHaveProperty("rawHtml");
-      expect(response.data[0]).not.toHaveProperty("screenshot");
-      expect(response.data[0]).not.toHaveProperty("links");
-      expect(response.data[0]).toHaveProperty("metadata");
-      expect(response.data[0].metadata).toHaveProperty("title");
-      expect(response.data[0].metadata).toHaveProperty("description");
-      expect(response.data[0].metadata).toHaveProperty("language");
-      expect(response.data[0].metadata).toHaveProperty("sourceURL");
-      expect(response.data[0].metadata).toHaveProperty("statusCode");
-      expect(response.data[0].metadata).not.toHaveProperty("error");
     }
   }, 60000); // 60 seconds timeout
 
@@ -230,39 +142,15 @@ describe('FirecrawlApp E2E Tests', () => {
         waitFor: 1000
       }
     } as CrawlParams, 30) as CrawlStatusResponse;
-    expect(response).not.toBeNull();
-    expect(response).toHaveProperty("total");
-    expect(response.total).toBeGreaterThan(0);
-    expect(response).toHaveProperty("creditsUsed");
-    expect(response.creditsUsed).toBeGreaterThan(0);
-    expect(response).toHaveProperty("expiresAt");
-    expect(new Date(response.expiresAt).getTime()).toBeGreaterThan(Date.now());
-    expect(response).toHaveProperty("status");
-    expect(response.status).toBe("completed");
     expect(response).not.toHaveProperty("next");
     expect(response.data.length).toBeGreaterThan(0);
-    expect(response.data[0]).not.toBeNull();
-    expect(response.data[0]).not.toBeUndefined();
     if (response.data[0]) {
       expect(response.data[0]).toHaveProperty("markdown");
-      expect(response.data[0].markdown).toContain("_Roast_");
       expect(response.data[0]).not.toHaveProperty('content'); // v0
       expect(response.data[0]).toHaveProperty("html");
-      expect(response.data[0].html).toContain("<h1");
       expect(response.data[0]).toHaveProperty("rawHtml");
-      expect(response.data[0].rawHtml).toContain("<h1");
       expect(response.data[0]).toHaveProperty("screenshot");
-      expect(response.data[0].screenshot).toContain("https://");
       expect(response.data[0]).toHaveProperty("links");
-      expect(response.data[0].links).not.toBeNull();
-      expect(response.data[0].links?.length).toBeGreaterThan(0);
-      expect(response.data[0]).toHaveProperty("metadata");
-      expect(response.data[0].metadata).toHaveProperty("title");
-      expect(response.data[0].metadata).toHaveProperty("description");
-      expect(response.data[0].metadata).toHaveProperty("language");
-      expect(response.data[0].metadata).toHaveProperty("sourceURL");
-      expect(response.data[0].metadata).toHaveProperty("statusCode");
-      expect(response.data[0].metadata).not.toHaveProperty("error");
     }
   }, 60000); // 60 seconds timeout
 
@@ -278,7 +166,7 @@ describe('FirecrawlApp E2E Tests', () => {
 
   test.concurrent('should check crawl status', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
-    const response = await app.asyncCrawlUrl('https://firecrawl.dev', { scrapeOptions: { formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links']}} as CrawlParams) as CrawlResponse;
+    const response = await app.asyncCrawlUrl('https://firecrawl.dev', { limit: 20, scrapeOptions: { formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links']}} as CrawlParams) as CrawlResponse;
     expect(response).not.toBeNull();
     expect(response.id).toBeDefined();
 
@@ -314,44 +202,15 @@ describe('FirecrawlApp E2E Tests', () => {
     expect(statusResponse).toHaveProperty("total");
     expect(statusResponse.success).toBe(true);
     if (statusResponse.success === true) {
-      expect(statusResponse.total).toBeGreaterThan(0);
-      expect(statusResponse).toHaveProperty("creditsUsed");
-      expect(statusResponse.creditsUsed).toBeGreaterThan(0);
-      expect(statusResponse).toHaveProperty("expiresAt");
-      expect(statusResponse.expiresAt.getTime()).toBeGreaterThan(Date.now());
-      expect(statusResponse).toHaveProperty("status");
       expect(statusResponse.status).toBe("completed");
       expect(statusResponse.data.length).toBeGreaterThan(0);
-      expect(statusResponse.data[0]).not.toBeNull();
-      expect(statusResponse.data[0]).not.toBeUndefined();
-      if (statusResponse.data[0]) {
-        expect(statusResponse.data[0]).toHaveProperty("markdown");
-        expect(statusResponse.data[0].markdown?.length).toBeGreaterThan(10);
-        expect(statusResponse.data[0]).not.toHaveProperty('content'); // v0
-        expect(statusResponse.data[0]).toHaveProperty("html");
-        expect(statusResponse.data[0].html).toContain("<div");
-        expect(statusResponse.data[0]).toHaveProperty("rawHtml");
-        expect(statusResponse.data[0].rawHtml).toContain("<div");
-        expect(statusResponse.data[0]).toHaveProperty("screenshot");
-        expect(statusResponse.data[0].screenshot).toContain("https://");
-        expect(statusResponse.data[0]).toHaveProperty("links");
-        expect(statusResponse.data[0].links).not.toBeNull();
-        expect(statusResponse.data[0].links?.length).toBeGreaterThan(0);
-        expect(statusResponse.data[0]).toHaveProperty("metadata");
-        expect(statusResponse.data[0].metadata).toHaveProperty("title");
-        expect(statusResponse.data[0].metadata).toHaveProperty("description");
-        expect(statusResponse.data[0].metadata).toHaveProperty("language");
-        expect(statusResponse.data[0].metadata).toHaveProperty("sourceURL");
-        expect(statusResponse.data[0].metadata).toHaveProperty("statusCode");
-        expect(statusResponse.data[0].metadata).not.toHaveProperty("error");
-      }
     }
   }, 60000); // 60 seconds timeout
 
   test.concurrent('should throw error for invalid API key on map', async () => {
     if (API_URL.includes('api.firecrawl.dev')) {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
-      await expect(invalidApp.mapUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 404");
+      await expect(invalidApp.mapUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 401");
     } else {
       const invalidApp = new FirecrawlApp({ apiKey: "invalid_api_key", apiUrl: API_URL });
       await expect(invalidApp.mapUrl('https://roastmywebsite.ai')).resolves.not.toThrow();
@@ -361,16 +220,9 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should throw error for blocklisted URL on map', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const blocklistedUrl = "https://facebook.com/fake-test";
-    await expect(app.mapUrl(blocklistedUrl)).rejects.toThrow("Request failed with status code 403");
+    await expect(app.mapUrl(blocklistedUrl)).rejects.toThrow("403");
   });
 
-  test.concurrent('should return successful response with valid preview token', async () => {
-    const app = new FirecrawlApp({ apiKey: process.env.PREVIEW_TOKEN, apiUrl: API_URL });
-    const response = await app.mapUrl('https://roastmywebsite.ai') as MapResponse;
-    expect(response).not.toBeNull();
-    expect(response.links?.length).toBeGreaterThan(0);
-  }, 30000); // 30 seconds timeout
-
   test.concurrent('should return successful response for valid map', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });    const response = await app.mapUrl('https://roastmywebsite.ai') as MapResponse;
     expect(response).not.toBeNull();
@@ -387,13 +239,11 @@ describe('FirecrawlApp E2E Tests', () => {
     const app = new FirecrawlApp({ apiUrl: API_URL, apiKey: TEST_API_KEY });
     const response = await app.search("firecrawl");
     expect(response.success).toBe(true);
-    console.log(response.data);
     expect(response.data?.length).toBeGreaterThan(0);
-    expect(response.data?.[0]?.markdown).toBeDefined();
-    expect(response.data?.[0]?.metadata).toBeDefined();
-    expect(response.data?.[0]?.metadata?.title).toBeDefined();
-    expect(response.data?.[0]?.metadata?.description).toBeDefined();
-  });
+    expect(response.data?.[0]?.markdown).not.toBeDefined();
+    expect(response.data?.[0]?.title).toBeDefined();
+    expect(response.data?.[0]?.description).toBeDefined();
+  }, 30000); // 30 seconds timeout
 
   test('should search with params object', async () => {
     const app = new FirecrawlApp({ apiUrl: API_URL, apiKey: TEST_API_KEY });
@@ -412,14 +262,13 @@ describe('FirecrawlApp E2E Tests', () => {
       expect(doc.markdown).toBeDefined();
       expect(doc.html).toBeDefined();
       expect(doc.links).toBeDefined();
-      expect(doc.metadata).toBeDefined();
-      expect(doc.metadata?.title).toBeDefined();
-      expect(doc.metadata?.description).toBeDefined();
+      expect(doc.title).toBeDefined();
+      expect(doc.description).toBeDefined();
     }
-  });
+  }, 30000); // 30 seconds timeout
 
   test('should handle invalid API key for search', async () => {
     const app = new FirecrawlApp({ apiUrl: API_URL, apiKey: "invalid_api_key" });
-    await expect(app.search("test query")).rejects.toThrow("Request failed with status code 404");
+    await expect(app.search("test query")).rejects.toThrow("Request failed with status code 401");
   });
 });

package/src/index.ts

@@ -209,6 +209,7 @@ export interface CrawlParams {
   maxDiscoveryDepth?: number;
   limit?: number;
   allowBackwardLinks?: boolean;
+  crawlEntireDomain?: boolean;
   allowExternalLinks?: boolean;
   ignoreSitemap?: boolean;
   scrapeOptions?: CrawlScrapeOptions;
@@ -226,6 +227,7 @@ export interface CrawlParams {
    * If not provided, the crawler may use the robots.txt crawl delay if available.
    */
   delay?: number;
+  maxConcurrency?: number;
 }
 
 /**
@@ -1012,9 +1014,10 @@ export default class FirecrawlApp {
     idempotencyKey?: string,
     webhook?: CrawlParams["webhook"],
     ignoreInvalidURLs?: boolean,
+    maxConcurrency?: number,
   ): Promise<BatchScrapeStatusResponse | ErrorResponse> {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData: any = { urls, webhook, ignoreInvalidURLs, ...params, origin: `js-sdk@${this.version}` };
+    let jsonData: any = { urls, webhook, ignoreInvalidURLs, maxConcurrency, ...params, origin: `js-sdk@${this.version}` };
     if (jsonData?.extract?.schema) {
       let schema = jsonData.extract.schema;
 

package/src/__tests__/e2e_withAuth/index.test.ts

@@ -1,330 +0,0 @@
-import FirecrawlApp, {
-  CrawlResponseV0,
-  CrawlStatusResponse,
-  CrawlStatusResponseV0,
-  FirecrawlDocumentV0,
-  ScrapeResponseV0,
-  SearchResponseV0,
-} from "../../index";
-import { v4 as uuidv4 } from "uuid";
-import dotenv from "dotenv";
-import { describe, test, expect } from "@jest/globals";
-
-dotenv.config();
-
-const TEST_API_KEY = process.env.TEST_API_KEY;
-const API_URL = "http://127.0.0.1:3002";
-
-describe('FirecrawlApp<"v0"> E2E Tests', () => {
-  test.concurrent("should throw error for no API key", async () => {
-    expect(() => {
-      new FirecrawlApp<"v0">({ apiKey: null, apiUrl: API_URL, version: "v0" });
-    }).toThrow("No API key provided");
-  });
-
-  test.concurrent(
-    "should throw error for invalid API key on scrape",
-    async () => {
-      const invalidApp = new FirecrawlApp<"v0">({
-        apiKey: "invalid_api_key",
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      await expect(
-        invalidApp.scrapeUrl("https://roastmywebsite.ai")
-      ).rejects.toThrow("Request failed with status code 401");
-    }
-  );
-
-  test.concurrent(
-    "should throw error for blocklisted URL on scrape",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const blocklistedUrl = "https://facebook.com/fake-test";
-      await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow(
-        "Request failed with status code 403"
-      );
-    }
-  );
-
-  test.concurrent(
-    "should return successful response with valid preview token",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: process.env.PREVIEW_TOKEN,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl(
-        "https://roastmywebsite.ai"
-      )) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.content).toContain("_Roast_");
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should return successful response for valid scrape",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl(
-        "https://roastmywebsite.ai"
-      )) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.content).toContain("_Roast_");
-      expect(response.data).toHaveProperty("markdown");
-      expect(response.data).toHaveProperty("metadata");
-      expect(response.data).not.toHaveProperty("html");
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should return successful response with valid API key and include HTML",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl("https://roastmywebsite.ai", {
-        pageOptions: { includeHtml: true },
-      })) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.content).toContain("_Roast_");
-      expect(response.data?.markdown).toContain("_Roast_");
-      expect(response.data?.html).toContain("<h1");
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should return successful response for valid scrape with PDF file",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl(
-        "https://arxiv.org/pdf/astro-ph/9301001.pdf"
-      )) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.content).toContain(
-        "We present spectrophotometric observations of the Broad Line Radio Galaxy"
-      );
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should return successful response for valid scrape with PDF file without explicit extension",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl(
-        "https://arxiv.org/pdf/astro-ph/9301001"
-      )) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.content).toContain(
-        "We present spectrophotometric observations of the Broad Line Radio Galaxy"
-      );
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should throw error for invalid API key on crawl",
-    async () => {
-      const invalidApp = new FirecrawlApp<"v0">({
-        apiKey: "invalid_api_key",
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      await expect(
-        invalidApp.crawlUrl("https://roastmywebsite.ai")
-      ).rejects.toThrow("Request failed with status code 401");
-    }
-  );
-
-  test.concurrent(
-    "should throw error for blocklisted URL on crawl",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const blocklistedUrl = "https://twitter.com/fake-test";
-      await expect(app.crawlUrl(blocklistedUrl)).rejects.toThrow(
-        "Request failed with status code 403"
-      );
-    }
-  );
-
-  test.concurrent(
-    "should return successful response for crawl and wait for completion",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.crawlUrl(
-        "https://roastmywebsite.ai",
-        { crawlerOptions: { excludes: ["blog/*"] } },
-        true,
-        10
-      )) as FirecrawlDocumentV0[];
-      expect(response).not.toBeNull();
-      expect(response[0].content).toContain("_Roast_");
-    },
-    60000
-  ); // 60 seconds timeout
-
-  test.concurrent("should handle idempotency key for crawl", async () => {
-    const app = new FirecrawlApp<"v0">({
-      apiKey: TEST_API_KEY,
-      apiUrl: API_URL,
-      version: "v0",
-    });
-    const uniqueIdempotencyKey = uuidv4();
-    const response = (await app.crawlUrl(
-      "https://roastmywebsite.ai",
-      { crawlerOptions: { excludes: ["blog/*"] } },
-      false,
-      2,
-      uniqueIdempotencyKey
-    )) as CrawlResponseV0;
-    expect(response).not.toBeNull();
-    expect(response.jobId).toBeDefined();
-
-    await expect(
-      app.crawlUrl(
-        "https://roastmywebsite.ai",
-        { crawlerOptions: { excludes: ["blog/*"] } },
-        true,
-        2,
-        uniqueIdempotencyKey
-      )
-    ).rejects.toThrow("Request failed with status code 409");
-  });
-
-  test.concurrent(
-    "should check crawl status",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response: any = (await app.crawlUrl(
-        "https://roastmywebsite.ai",
-        { crawlerOptions: { excludes: ["blog/*"] } },
-        false
-      )) as CrawlResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.jobId).toBeDefined();
-
-      let statusResponse = await app.checkCrawlStatus(response.jobId);
-      const maxChecks = 15;
-      let checks = 0;
-
-      while (statusResponse.status === "active" && checks < maxChecks) {
-        await new Promise((resolve) => setTimeout(resolve, 5000));
-        expect(statusResponse.partial_data).not.toBeNull();
-        // expect(statusResponse.current).toBeGreaterThanOrEqual(1);
-        statusResponse = (await app.checkCrawlStatus(
-          response.jobId
-        )) as CrawlStatusResponseV0;
-        checks++;
-      }
-
-      expect(statusResponse).not.toBeNull();
-      expect(statusResponse.success).toBe(true);
-      expect(statusResponse.status).toBe("completed");
-      expect(statusResponse.total).toEqual(statusResponse.current);
-      expect(statusResponse.current_step).not.toBeNull();
-      expect(statusResponse.current).toBeGreaterThanOrEqual(1);
-
-      expect(statusResponse?.data?.length).toBeGreaterThan(0);
-    },
-    35000
-  ); // 35 seconds timeout
-
-  test.concurrent(
-    "should return successful response for search",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.search("test query")) as SearchResponseV0;
-      expect(response).not.toBeNull();
-      expect(response?.data?.[0]?.content).toBeDefined();
-      expect(response?.data?.length).toBeGreaterThan(2);
-    },
-    30000
-  ); // 30 seconds timeout
-
-  test.concurrent(
-    "should throw error for invalid API key on search",
-    async () => {
-      const invalidApp = new FirecrawlApp<"v0">({
-        apiKey: "invalid_api_key",
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      await expect(invalidApp.search("test query")).rejects.toThrow(
-        "Request failed with status code 401"
-      );
-    }
-  );
-
-  test.concurrent(
-    "should perform LLM extraction",
-    async () => {
-      const app = new FirecrawlApp<"v0">({
-        apiKey: TEST_API_KEY,
-        apiUrl: API_URL,
-        version: "v0",
-      });
-      const response = (await app.scrapeUrl("https://mendable.ai", {
-        extractorOptions: {
-          mode: "llm-extraction",
-          extractionPrompt:
-            "Based on the information on the page, find what the company's mission is and whether it supports SSO, and whether it is open source",
-          extractionSchema: {
-            type: "object",
-            properties: {
-              company_mission: { type: "string" },
-              supports_sso: { type: "boolean" },
-              is_open_source: { type: "boolean" },
-            },
-            required: ["company_mission", "supports_sso", "is_open_source"],
-          },
-        },
-      })) as ScrapeResponseV0;
-      expect(response).not.toBeNull();
-      expect(response.data?.llm_extraction).toBeDefined();
-      const llmExtraction = response.data?.llm_extraction;
-      expect(llmExtraction?.company_mission).toBeDefined();
-      expect(typeof llmExtraction?.supports_sso).toBe("boolean");
-      expect(typeof llmExtraction?.is_open_source).toBe("boolean");
-    },
-    30000
-  ); // 30 seconds timeout
-});

package/src/__tests__/fixtures/scrape.json

@@ -1,22 +0,0 @@
-{
-    "success": true,
-    "data": {
-        "content": "\n\n[![Mendable logo](https://mendable.ai/Frame%20566%20(2)Mendable](/)\n\n*   Getting started\n*   Use Cases\n*   [Docs](https://docs.mendable.ai)\n    \n*   [Pricing](/pricing)\n    \n*   [Blog](/blog)\n    \n\nOpen main menu\n\n[Sign In](/signin)\n[Get Started](/signup)\n\n![](https://mendable.ai/fullbgdsm.png)\n\n[$ npm i @mendable/search](https://docs.mendable.ai)\n\nJust in time answers  \nfor Sales and Support\n============================================\n\nTrain a secure AI on your technical resources that answers customer and employee questions so your team doesn't have to\n\nGet Started\n\nTalk to Us\n\nBacked BY\n\n![Y Combinator Logo](https://mendable.ai/yc.svg)Combinator\n\ninvisible\n\nAssistant\n\nHi, how can I help you?\n\nGenerating\n\nLoading...\n\n![Mendable loading placeholder image](https://mendable.ai/heroloading.png)\n\nFrom small startups to Fortune 500\n\nTrusted by top companies\n------------------------\n\n![Snapchat](https://mendable.ai/customers/snapchat2.svg)\n\n![MongoDB](https://mendable.ai/customers/mongo.svg)\n\n![Langchain](https://mendable.ai/customers/coinbase.svg)\n\n![Worldline](https://mendable.ai/customers/world.svg)\n\n![Nylas](https://mendable.ai/customers/nylass.svg)\n\n![Spectrocloud](https://mendable.ai/customers/spectro.svg)\n\n![Merge](https://mendable.ai/customers/merge.svg)\n\n![0x](https://mendable.ai/customers/zeroxx.svg)\n\n![Tecton.ai](https://mendable.ai/customers/tecton.svg)\n\n![Llama Index](https://mendable.ai/customers/llamaindex.png)\n\nDeploy a knowledgable technical AI anywhere\n\nUse Mendable for\n----------------\n\n[Docs & Knowledge Base](/usecases/documentation)\n\n-------------------------------------------------\n\nDecrease tickets & activation times with an AI assistant\n\n[Customer Success Enablement](/usecases/cs-enablement)\n\n-------------------------------------------------------\n\nUse a technical AI copilot to increase retention\n\n[Sales Enablement](/usecases/sales-enablement)\n\n-----------------------------------------------\n\nUse a technical AI copilot to build trust with prospects\n\n[Product Copilot](/usecases/productcopilot)\n\n--------------------------------------------\n\nSpeed up adoption with a technical assistant in your app\n\nSee how companies implement Mendable\n------------------------------------\n\n![](https://mendable.ai/langchain.png)\n\n[Langchain Docs](https://python.langchain.com)\n\n-----------------------------------------------\n\nOne of the most popular frameworks for developing AI applications\n\nhttps://python.langchain.com\n\n![](https://mendable.ai/0xlogo.png)\n\n[0x Docs](https://0x.org/docs)\n\n-------------------------------\n\n0x offers the core building blocks to create the most powerful Web3 apps\n\nhttps://0x.org/docs\n\n![](https://mendable.ai/zenlytics.png)\n\n[Zenlytics](https://docs.zenlytic.com)\n\n---------------------------------------\n\nSelf-serve analytics tool that helps you answer the deeper questions you have about your data\n\nhttps://docs.zenlytic.com\n\n![](https://mendable.ai/LlamaIndex.png)\n\n[Llama Index](http://gpt-index.readthedocs.io)\n\n-----------------------------------------------\n\nA central interface to connect your LLM’s with external data.\n\nhttp://gpt-index.readthedocs.io\n\n![](https://mendable.ai/spectrocloud-white.png)\n\n[Spectrocloud](https://docs.spectrocloud.com/)\n\n-----------------------------------------------\n\nK8s management uniquely built for scale. Manage the lifecycle of any type of cluster.\n\nhttps://docs.spectrocloud.com/\n\n![](https://mendable.ai/codegpt.png)\n\n[Code GPT](https://www.codegpt.co/)\n\n------------------------------------\n\nWith over 450,000 installs, CodeGPT brings AI inside your code editor.\n\nhttps://www.codegpt.co/\n\nAnd many more...\n\nFrom SSO to BYOK\n\nEnterprise-grade security\n-------------------------\n\n#### SOC 2 Type II\n\nMendable is SOC 2 Type II certified. Check out our [AI Trust Center](https://mendable.wolfia.com/?ref=mendable-website)\n for additional information.\n\n#### SSO (SAML, OIDC, OAuth)\n\nSupports SAML 2.0, OpenID Connect, and OAuth 2.0 for single sign-on (SSO) and identity federation.\n\n#### RBAC (Project and chunk level)\n\nRole-based access control to ensure that only the right people have access to the right data.\n\n#### Secure Data Connectors\n\nIntegrate securely to Google Drive, Salesforce, Zendesk and more using OAuth 2.0.\n\n#### BYOK / BYOM\n\nBring your own key or custom model to Mendable to ensure compliance.\n\n#### Rate Limiting\n\nProject and user rate limit protection to prevent abuse and ensure availability.\n\nOver 20+ data connectors\n\nStart by connecting your data\n-----------------------------\n\nMendable offers managed ingestion through a simple online GUI and through our API. You can easily add, modify, or delete different types of sources.\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![github-mark](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![medium](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![gitbook](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![docusaurus](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![readme](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![notion](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![upload](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![confluence](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![drive](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![youtube](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![pdf](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![wordpress](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![slack](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![readme](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![website](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![zendesk](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\nEasily Teach Your Model\n\nCustomize your model\n--------------------\n\nCustomize base model properties\n\nGPT-3.5-Turbo and GPT-4 are supported with a variety of base models coming soon\n\nTraining through answer correction\n\nCorrect the answers generated by the model and it will instantly learn from your feedback\n\nCustom prompt edits\n\nEdit the prompt to prevent hallucinations, maintain voice and format requirements\n\nKeep your data always updated\n\nMendable reingestion process offers CRON jobs and webhooks to keep your data synced and always up to date\n\nSupport Link\n\nHave customers redirected to your customer support link when the bot can't answer their questions\n\nPrivacy-first features\n\nMendable provides custom private, open source LLMs depending on your needs\n\n### Make it perfect for your use case\n\nWe know every uses case is slightly different so the Mendable platform allows you to customize your model to fit your company's needs through multiple features.\n\n*   Support for multiple base LLM models (including privacy first models)\n*   Training through answer correction\n*   Custom prompt edits\n*   Model creativity control\n\nTeach Model\n\nContinuous Training\n-------------------\n\nCoach the model by correcting the wrong responses, keeping your chat applications always up to date\n\nMore than just a chatbot\n\nTools and Actions\n-----------------\n\nGive your AI access to tools for augmentation and actions for automation. Integrate with any API\n\n![](https://mendable.ai/tools-purple.svg)![](https://mendable.ai/actions-yellow-svg.svg)\n\n![](https://mendable.ai/tools-pic.png)\n\nReact, Vanilla JS, API\n\nChoose your component\n---------------------\n\nMendable provides a variety of components ranging from search bars, to chat bubbles, to full CLIs built on our API. Customize them or easily build your own\n\n![Mendable component](https://mendable.ai/Frame%20597%20(3)\n\n    \n    import { MendableSearchBar } from '@mendable/search'\n    <MendableSearchBar anon_key={MENDABLE_ANON_KEY} />\n    \n\nFrom zero to production in minutes\n\nDeploy anywhere\n---------------\n\nDeploy Mendable internally, externally, or both. Our API allows you to send and query data from anywhere.\n\nView Documentation\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2756%27%20height=%2756%27/%3e)![Saif Khan](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\nMendables integration on Nylas is a goldmine of data. Now, the product team has a direct source of user feedback, questions, and problems. It's amazing!\n\nSaif Khan \\- Product @ NylasKarl Cardenas \\- Director @ SpectroCloudGuillermo Rauch \\- CEO @ Vercel\n\nAI Chat Infrastructure built for production\n\nEnterprise ready out of the box\n-------------------------------\n\nVerified Sources\n----------------\n\nReduce hallucinations by grounding answers with sources from your documentation\n\nEnterprise Grade Security\n-------------------------\n\nOur platform is built for enterprises in mind. We provide RBAC, bring your own model, and SLAs\n\nReady for the whole team\n------------------------\n\nMendable supports single-sign-on so your entire team can train, manage your custom AI\n\nExplore your dashboard\n\nGet insights from usage\n-----------------------\n\nUsage\n\nNumber of chat messages per month\n\n### Understand all interactions\n\nUnravel your users' queries, track their interactions, customize responses, and monitor your product usage effortlessly.\n\n*   \\-Gain key insights into user queries\n*   \\-Monitor real-time product-user interactions\n*   \\-Fine-tune your model for optimized responses\n*   \\-Track and evaluate Mendable usage\n\n### Insights beyond conversations\n\nLearn what your users are asking, how they are asking, and their satisfaction level with the answers. Teach the model based on the answers rating and improve the model's performance.\n\nOur wall of love\n\nDon't take our word for it\n--------------------------\n\nEmpower your users with AI powered search\n\nBuild an AI technical assistant in minutes\n------------------------------------------\n\nTry it out\n\nFrequently asked questions\n--------------------------\n\nIf you have anything else you want to ask,[reach out to us](mailto:hello@mendable.ai)\n.\n\n*   *   ### Is it free?\n        \n        We have a free plan that gives you 500 message credits. It is also free for certain Open source projects. Contact us to see if your project is eligible.\n        \n    *   ### Do you train your AI model with my code?\n        \n        Currently, Mendable does not look at any of your repository's code. However, in the future we may add it. We will always give you the option to opt out of sharing your data.\n        \n*   *   ### How do I remove the Powered by Mendable?\n        \n        To remove the Powered by Mendable, you need to upgrade to an enterprise or custom plan. Contact us at [garrett@mendable.ai](mailto:garrett@mendable.ai)\n         and we can help you out.\n        \n    *   ### How do I get an anon key?\n        \n        To get your anon key you need to sign up at [mendable.ai](https://mendable.ai)\n         and create a project. Then you can find your anon key in the API Keys section of the dashboard. Anon keys are used for client-side while API keys are used for server-side.\n        \n*   *   ### Which model does Mendable use?\n        \n        Mendable offers gpt-3.5-turbo, gpt-4, claude-2 and more. If you'd like a custom model, contact us and we can help you out.\n        \n    *   ### Is GPT-4 pricing different?\n        \n        Yes, right now GPT-4 will cost 3 requests per message instead of 1 (gpt-3.5-turbo). That means that instead of 500 messages, you will get around 166 messages if you only use GPT-4.\n        \n*   *   ### Can you correct the AI response?\n        \n        Yes, Mendable offers a 'teach the model' functionality where you can correct the AI response and it will learn from it.\n        \n    *   ### How can I integrate Mendable with my application?\n        \n        Probably! Check out the Mendable documentation here [https://docs.mendable.ai](https://docs.mendable.ai)\n         to better understand how you can start integrating.\n        \n*   *   ### Is it 100% accurate?\n        \n        Like Humans, AI will never be 100% accurate. So we can't assure you that every solution will be correct.\n        \n    *   ### How do I cancel my subscription?\n        \n        Simply log into our platform, go to your account and click on \"Open customer portal\" button. There you will be able to cancel/modify it through Stripe.\n        \n*   *   ### How does Mendable work?\n        \n        Our application syncs with your documentation and support channels, then uses your docs and previously answered questions to suggest possible answers.\n        \n    *   ### Are you open-source?\n        \n        Currently not - although we have some open source components and integrations. If you have input here, please message us at.[hello@mendable.ai](mailto:hello@mendable.ai)\n        .\n        \n*   *   ### How does Mendable price custom plans?\n        \n        #### 1\\. Use case\n        \n        *   Mendable differentiates between internal and external use cases.\n        *   With Mendable, we give you the ability to use our chat bots for a variety of use cases, both for internal efficiency and external communication to your customers.\n        \n        #### 2\\. Total usage\n        \n        *   For specifically external use cases, you will only pay for the value you're receiving.\n        *   Mendable will look at the total number of messages sent during a month.\n        \n        #### 3\\. Custom work\n        \n        *   If there are any special feature requests (custom data connectors, etc.), we are happy to discuss these requirements!\n        \n\nWe use tracking cookies to understand how you use the product and help us improve it!  \nPlease accept cookies to help us improve.\n\nAccept CookiesDecline Cookies\n\n![Mendable logo](https://mendable.ai/Frame%20566%20(2)[Mendable](#_)\n\n[Instagram](https://instagram.com/sideguide.dev)\n[Twitter](https://twitter.com/mendableai)\n[GitHub](https://github.com/sideguide)\n[Discord](https://discord.com/invite/kJufGDb7AA)\n\n![SOC 2 Type II](https://mendable.ai/soc2type2badge.png)\n\nDocumentation\n\n*   [Getting Started](/signup)\n    \n\n*   [API Docs](https://docs.mendable.ai)\n    \n\n*   [Integrations](https://docs.mendable.ai/integrations/slack)\n    \n\n*   [Examples](https://docs.mendable.ai/examples)\n    \n\n*   [Tools & Actions](https://docs.mendable.ai/tools)\n    \n\nUse Cases\n\n*   [Sales Enablement](/usecases/sales-enablement)\n    \n\n*   [Knowledge Base](/usecases/documentation)\n    \n\n*   [CS Enablement](/usecases/cs-enablement)\n    \n\n*   [Product Copilot](/usecases/productcopilot)\n    \n\nResources\n\n*   [Pricing](/pricing)\n    \n\n*   [Changelog](https://docs.mendable.ai/changelog)\n    \n\n*   [Security](/security)\n    \n\n*   [AI Trust Center](https://mendable.wolfia.com/?ref=mendable-footer)\n    \n\nCompany\n\n*   [Blog](/blog)\n    \n\n*   [Contact](mailto:garrett@mendable.ai)\n    \n\n© 2024 SideGuide - SideGuide Technologies Inc.\n\n[System Status](https://mendable.betteruptime.com)\n\n[Status](https://mendable.betteruptime.com)\n[Privacy Policy](/privacy-policy)\n[Privacy](/privacy-policy)\n[Terms](/terms-of-conditions)",
-        "markdown": "\n\n[![Mendable logo](/Frame 566 (2).png)Mendable](/)\n\n*   Getting started\n*   Use Cases\n*   [Docs](https://docs.mendable.ai)\n    \n*   [Pricing](/pricing)\n    \n*   [Blog](/blog)\n    \n\nOpen main menu\n\n[Sign In](/signin)\n[Get Started](/signup)\n\n![](/fullbgdsm.png)\n\n[$ npm i @mendable/search](https://docs.mendable.ai)\n\nJust in time answers  \nfor Sales and Support\n============================================\n\nTrain a secure AI on your technical resources that answers customer and employee questions so your team doesn't have to\n\nGet Started\n\nTalk to Us\n\nBacked BY\n\n![Y Combinator Logo](/yc.svg)Combinator\n\ninvisible\n\nAssistant\n\nHi, how can I help you?\n\nGenerating\n\nLoading...\n\n![Mendable loading placeholder image](/heroloading.png)\n\nFrom small startups to Fortune 500\n\nTrusted by top companies\n------------------------\n\n![Snapchat](/customers/snapchat2.svg)\n\n![MongoDB](/customers/mongo.svg)\n\n![Langchain](/customers/coinbase.svg)\n\n![Worldline](/customers/world.svg)\n\n![Nylas](/customers/nylass.svg)\n\n![Spectrocloud](/customers/spectro.svg)\n\n![Merge](/customers/merge.svg)\n\n![0x](/customers/zeroxx.svg)\n\n![Tecton.ai](/customers/tecton.svg)\n\n![Llama Index](/customers/llamaindex.png)\n\nDeploy a knowledgable technical AI anywhere\n\nUse Mendable for\n----------------\n\n[Docs & Knowledge Base](/usecases/documentation)\n\n-------------------------------------------------\n\nDecrease tickets & activation times with an AI assistant\n\n[Customer Success Enablement](/usecases/cs-enablement)\n\n-------------------------------------------------------\n\nUse a technical AI copilot to increase retention\n\n[Sales Enablement](/usecases/sales-enablement)\n\n-----------------------------------------------\n\nUse a technical AI copilot to build trust with prospects\n\n[Product Copilot](/usecases/productcopilot)\n\n--------------------------------------------\n\nSpeed up adoption with a technical assistant in your app\n\nSee how companies implement Mendable\n------------------------------------\n\n![](/langchain.png)\n\n[Langchain Docs](https://python.langchain.com)\n\n-----------------------------------------------\n\nOne of the most popular frameworks for developing AI applications\n\nhttps://python.langchain.com\n\n![](/0xlogo.png)\n\n[0x Docs](https://0x.org/docs)\n\n-------------------------------\n\n0x offers the core building blocks to create the most powerful Web3 apps\n\nhttps://0x.org/docs\n\n![](/zenlytics.png)\n\n[Zenlytics](https://docs.zenlytic.com)\n\n---------------------------------------\n\nSelf-serve analytics tool that helps you answer the deeper questions you have about your data\n\nhttps://docs.zenlytic.com\n\n![](/LlamaIndex.png)\n\n[Llama Index](http://gpt-index.readthedocs.io)\n\n-----------------------------------------------\n\nA central interface to connect your LLM’s with external data.\n\nhttp://gpt-index.readthedocs.io\n\n![](/spectrocloud-white.png)\n\n[Spectrocloud](https://docs.spectrocloud.com/)\n\n-----------------------------------------------\n\nK8s management uniquely built for scale. Manage the lifecycle of any type of cluster.\n\nhttps://docs.spectrocloud.com/\n\n![](/codegpt.png)\n\n[Code GPT](https://www.codegpt.co/)\n\n------------------------------------\n\nWith over 450,000 installs, CodeGPT brings AI inside your code editor.\n\nhttps://www.codegpt.co/\n\nAnd many more...\n\nFrom SSO to BYOK\n\nEnterprise-grade security\n-------------------------\n\n#### SOC 2 Type II\n\nMendable is SOC 2 Type II certified. Check out our [AI Trust Center](https://mendable.wolfia.com/?ref=mendable-website)\n for additional information.\n\n#### SSO (SAML, OIDC, OAuth)\n\nSupports SAML 2.0, OpenID Connect, and OAuth 2.0 for single sign-on (SSO) and identity federation.\n\n#### RBAC (Project and chunk level)\n\nRole-based access control to ensure that only the right people have access to the right data.\n\n#### Secure Data Connectors\n\nIntegrate securely to Google Drive, Salesforce, Zendesk and more using OAuth 2.0.\n\n#### BYOK / BYOM\n\nBring your own key or custom model to Mendable to ensure compliance.\n\n#### Rate Limiting\n\nProject and user rate limit protection to prevent abuse and ensure availability.\n\nOver 20+ data connectors\n\nStart by connecting your data\n-----------------------------\n\nMendable offers managed ingestion through a simple online GUI and through our API. You can easily add, modify, or delete different types of sources.\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![github-mark](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![medium](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![gitbook](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![docusaurus](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![readme](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![notion](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![upload](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![confluence](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![drive](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![youtube](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![pdf](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![wordpress](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![slack](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![readme](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![website](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2736%27%20height=%2736%27/%3e)![zendesk](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\nEasily Teach Your Model\n\nCustomize your model\n--------------------\n\nCustomize base model properties\n\nGPT-3.5-Turbo and GPT-4 are supported with a variety of base models coming soon\n\nTraining through answer correction\n\nCorrect the answers generated by the model and it will instantly learn from your feedback\n\nCustom prompt edits\n\nEdit the prompt to prevent hallucinations, maintain voice and format requirements\n\nKeep your data always updated\n\nMendable reingestion process offers CRON jobs and webhooks to keep your data synced and always up to date\n\nSupport Link\n\nHave customers redirected to your customer support link when the bot can't answer their questions\n\nPrivacy-first features\n\nMendable provides custom private, open source LLMs depending on your needs\n\n### Make it perfect for your use case\n\nWe know every uses case is slightly different so the Mendable platform allows you to customize your model to fit your company's needs through multiple features.\n\n*   Support for multiple base LLM models (including privacy first models)\n*   Training through answer correction\n*   Custom prompt edits\n*   Model creativity control\n\nTeach Model\n\nContinuous Training\n-------------------\n\nCoach the model by correcting the wrong responses, keeping your chat applications always up to date\n\nMore than just a chatbot\n\nTools and Actions\n-----------------\n\nGive your AI access to tools for augmentation and actions for automation. Integrate with any API\n\n![](/tools-purple.svg)![](/actions-yellow-svg.svg)\n\n![](/tools-pic.png)\n\nReact, Vanilla JS, API\n\nChoose your component\n---------------------\n\nMendable provides a variety of components ranging from search bars, to chat bubbles, to full CLIs built on our API. Customize them or easily build your own\n\n![Mendable component](/Frame 597 (3).png)\n\n    \n    import { MendableSearchBar } from '@mendable/search'\n    <MendableSearchBar anon_key={MENDABLE_ANON_KEY} />\n    \n\nFrom zero to production in minutes\n\nDeploy anywhere\n---------------\n\nDeploy Mendable internally, externally, or both. Our API allows you to send and query data from anywhere.\n\nView Documentation\n\n![](data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%2756%27%20height=%2756%27/%3e)![Saif Khan](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)\n\nMendables integration on Nylas is a goldmine of data. Now, the product team has a direct source of user feedback, questions, and problems. It's amazing!\n\nSaif Khan \\- Product @ NylasKarl Cardenas \\- Director @ SpectroCloudGuillermo Rauch \\- CEO @ Vercel\n\nAI Chat Infrastructure built for production\n\nEnterprise ready out of the box\n-------------------------------\n\nVerified Sources\n----------------\n\nReduce hallucinations by grounding answers with sources from your documentation\n\nEnterprise Grade Security\n-------------------------\n\nOur platform is built for enterprises in mind. We provide RBAC, bring your own model, and SLAs\n\nReady for the whole team\n------------------------\n\nMendable supports single-sign-on so your entire team can train, manage your custom AI\n\nExplore your dashboard\n\nGet insights from usage\n-----------------------\n\nUsage\n\nNumber of chat messages per month\n\n### Understand all interactions\n\nUnravel your users' queries, track their interactions, customize responses, and monitor your product usage effortlessly.\n\n*   \\-Gain key insights into user queries\n*   \\-Monitor real-time product-user interactions\n*   \\-Fine-tune your model for optimized responses\n*   \\-Track and evaluate Mendable usage\n\n### Insights beyond conversations\n\nLearn what your users are asking, how they are asking, and their satisfaction level with the answers. Teach the model based on the answers rating and improve the model's performance.\n\nOur wall of love\n\nDon't take our word for it\n--------------------------\n\nEmpower your users with AI powered search\n\nBuild an AI technical assistant in minutes\n------------------------------------------\n\nTry it out\n\nFrequently asked questions\n--------------------------\n\nIf you have anything else you want to ask,[reach out to us](mailto:hello@mendable.ai)\n.\n\n*   *   ### Is it free?\n        \n        We have a free plan that gives you 500 message credits. It is also free for certain Open source projects. Contact us to see if your project is eligible.\n        \n    *   ### Do you train your AI model with my code?\n        \n        Currently, Mendable does not look at any of your repository's code. However, in the future we may add it. We will always give you the option to opt out of sharing your data.\n        \n*   *   ### How do I remove the Powered by Mendable?\n        \n        To remove the Powered by Mendable, you need to upgrade to an enterprise or custom plan. Contact us at [garrett@mendable.ai](mailto:garrett@mendable.ai)\n         and we can help you out.\n        \n    *   ### How do I get an anon key?\n        \n        To get your anon key you need to sign up at [mendable.ai](https://mendable.ai)\n         and create a project. Then you can find your anon key in the API Keys section of the dashboard. Anon keys are used for client-side while API keys are used for server-side.\n        \n*   *   ### Which model does Mendable use?\n        \n        Mendable offers gpt-3.5-turbo, gpt-4, claude-2 and more. If you'd like a custom model, contact us and we can help you out.\n        \n    *   ### Is GPT-4 pricing different?\n        \n        Yes, right now GPT-4 will cost 3 requests per message instead of 1 (gpt-3.5-turbo). That means that instead of 500 messages, you will get around 166 messages if you only use GPT-4.\n        \n*   *   ### Can you correct the AI response?\n        \n        Yes, Mendable offers a 'teach the model' functionality where you can correct the AI response and it will learn from it.\n        \n    *   ### How can I integrate Mendable with my application?\n        \n        Probably! Check out the Mendable documentation here [https://docs.mendable.ai](https://docs.mendable.ai)\n         to better understand how you can start integrating.\n        \n*   *   ### Is it 100% accurate?\n        \n        Like Humans, AI will never be 100% accurate. So we can't assure you that every solution will be correct.\n        \n    *   ### How do I cancel my subscription?\n        \n        Simply log into our platform, go to your account and click on \"Open customer portal\" button. There you will be able to cancel/modify it through Stripe.\n        \n*   *   ### How does Mendable work?\n        \n        Our application syncs with your documentation and support channels, then uses your docs and previously answered questions to suggest possible answers.\n        \n    *   ### Are you open-source?\n        \n        Currently not - although we have some open source components and integrations. If you have input here, please message us at.[hello@mendable.ai](mailto:hello@mendable.ai)\n        .\n        \n*   *   ### How does Mendable price custom plans?\n        \n        #### 1\\. Use case\n        \n        *   Mendable differentiates between internal and external use cases.\n        *   With Mendable, we give you the ability to use our chat bots for a variety of use cases, both for internal efficiency and external communication to your customers.\n        \n        #### 2\\. Total usage\n        \n        *   For specifically external use cases, you will only pay for the value you're receiving.\n        *   Mendable will look at the total number of messages sent during a month.\n        \n        #### 3\\. Custom work\n        \n        *   If there are any special feature requests (custom data connectors, etc.), we are happy to discuss these requirements!\n        \n\nWe use tracking cookies to understand how you use the product and help us improve it!  \nPlease accept cookies to help us improve.\n\nAccept CookiesDecline Cookies\n\n![Mendable logo](/Frame 566 (2).png)[Mendable](#_)\n\n[Instagram](https://instagram.com/sideguide.dev)\n[Twitter](https://twitter.com/mendableai)\n[GitHub](https://github.com/sideguide)\n[Discord](https://discord.com/invite/kJufGDb7AA)\n\n![SOC 2 Type II](/soc2type2badge.png)\n\nDocumentation\n\n*   [Getting Started](/signup)\n    \n\n*   [API Docs](https://docs.mendable.ai)\n    \n\n*   [Integrations](https://docs.mendable.ai/integrations/slack)\n    \n\n*   [Examples](https://docs.mendable.ai/examples)\n    \n\n*   [Tools & Actions](https://docs.mendable.ai/tools)\n    \n\nUse Cases\n\n*   [Sales Enablement](/usecases/sales-enablement)\n    \n\n*   [Knowledge Base](/usecases/documentation)\n    \n\n*   [CS Enablement](/usecases/cs-enablement)\n    \n\n*   [Product Copilot](/usecases/productcopilot)\n    \n\nResources\n\n*   [Pricing](/pricing)\n    \n\n*   [Changelog](https://docs.mendable.ai/changelog)\n    \n\n*   [Security](/security)\n    \n\n*   [AI Trust Center](https://mendable.wolfia.com/?ref=mendable-footer)\n    \n\nCompany\n\n*   [Blog](/blog)\n    \n\n*   [Contact](mailto:garrett@mendable.ai)\n    \n\n© 2024 SideGuide - SideGuide Technologies Inc.\n\n[System Status](https://mendable.betteruptime.com)\n\n[Status](https://mendable.betteruptime.com)\n[Privacy Policy](/privacy-policy)\n[Privacy](/privacy-policy)\n[Terms](/terms-of-conditions)",
-        "metadata": {
-            "title": "Mendable",
-            "description": "Mendable allows you to easily build AI chat applications. Ingest, customize, then deploy with one line of code anywhere you want. Brought to you by SideGuide",
-            "robots": "follow, index",
-            "ogTitle": "Mendable",
-            "ogDescription": "Mendable allows you to easily build AI chat applications. Ingest, customize, then deploy with one line of code anywhere you want. Brought to you by SideGuide",
-            "ogUrl": "https://mendable.ai/",
-            "ogImage": "https://mendable.ai/mendable_new_og1.png",
-            "ogLocaleAlternate": [],
-            "ogSiteName": "Mendable",
-            "sourceURL": "https://mendable.ai",
-            "sitemap": {
-            "changefreq": "hourly"
-            }
-        }
-    }
-}

package/src/__tests__/index.test.ts

@@ -1,57 +0,0 @@
-import { describe, expect, jest, test } from '@jest/globals';
-
-import FirecrawlApp from '../index';
-import axios from 'axios';
-import { join } from 'path';
-import { readFile } from 'fs/promises';
-
-// Mock jest and set the type
-jest.mock('axios');
-const mockedAxios = axios as jest.Mocked<typeof axios>;
-
-// Get the fixure data from the JSON file in ./fixtures
-async function loadFixture(name: string): Promise<string> {
-  return await readFile(join(__dirname, 'fixtures', `${name}.json`), 'utf-8')
-}
-
-const API_URL = process.env.API_URL ?? "https://api.firecrawl.dev";
-
-describe('the firecrawl JS SDK', () => {
-
-  test('Should require an API key only for cloud service', async () => {
-    if (API_URL.includes('api.firecrawl.dev')) {
-      // Should throw for cloud service
-      expect(() => {
-        new FirecrawlApp({ apiKey: undefined, apiUrl: API_URL });
-      }).toThrow('No API key provided');
-    } else {
-      // Should not throw for self-hosted
-      expect(() => {
-        new FirecrawlApp({ apiKey: undefined, apiUrl: API_URL });
-      }).not.toThrow();
-    }
-  });
-
-  test('Should return scraped data from a /scrape API call', async () => {
-    const mockData = await loadFixture('scrape');
-    mockedAxios.post.mockResolvedValue({
-      status: 200,
-      data: JSON.parse(mockData),
-    });
-
-    const apiKey = 'YOUR_API_KEY'
-    const app = new FirecrawlApp<"v0">({ apiKey });
-    // Scrape a single URL
-    const url = 'https://mendable.ai';
-    const scrapedData = await app.scrapeUrl(url);
-
-    expect(mockedAxios.post).toHaveBeenCalledTimes(1);
-    expect(mockedAxios.post).toHaveBeenCalledWith(
-      expect.stringMatching(/^https:\/\/api.firecrawl.dev/),
-      expect.objectContaining({ url }),
-      expect.objectContaining({ headers: expect.objectContaining({'Authorization': `Bearer ${apiKey}`}) }),
-    )
-    expect(scrapedData.success).toBe(true);
-    expect(scrapedData?.data?.metadata.title).toEqual('Mendable');
-  });
-})