> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibeflow.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Firecrawl

> Scrape URLs, search the web, and crawl websites into LLM-ready markdown

Firecrawl integration for scraping URLs, searching the web, autonomous web data gathering, and secure browser sessions to turn websites into LLM-ready markdown.

**Required Configuration:**

* API key authentication

## Setup

<Steps>
  <Step title="Create a Firecrawl Account">
    Sign up or log in at [firecrawl.dev](https://firecrawl.dev).
  </Step>

  <Step title="Generate an API Key">
    Go to your [Firecrawl dashboard](https://firecrawl.dev/app) and generate a new API key.
  </Step>

  <Step title="Add API Key to VibeFlow">
    In VibeFlow, navigate to **Settings** > **Connectors**, select **Firecrawl**, and paste your API key into the connector modal.

    Your API key is encrypted by default and stored securely.
  </Step>
</Steps>

## Available Endpoints

<AccordionGroup>
  <Accordion title="POST /api/actions/firecrawl/scrape">
    Scrape a single URL and extract its content.
  </Accordion>

  <Accordion title="POST /api/actions/firecrawl/search">
    Search the web and optionally scrape the results.
  </Accordion>

  <Accordion title="POST /api/actions/firecrawl/crawl">
    Start a crawl job on a URL.
  </Accordion>

  <Accordion title="GET /api/actions/firecrawl/crawl/{id}">
    Get the status of a crawl job.
  </Accordion>

  <Accordion title="POST /api/actions/firecrawl/map">
    Map all URLs from a website.
  </Accordion>

  <Accordion title="POST /api/actions/firecrawl/batch/scrape">
    Batch scrape multiple URLs in a single job.
  </Accordion>

  <Accordion title="GET /api/actions/firecrawl/batch/scrape/{id}">
    Get the status of a batch scrape job.
  </Accordion>
</AccordionGroup>