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

# Firecrawl: Crawl

> Crawl a website from a starting URL, following its links to scrape many pages, with depth, page limit and path filters. Firecrawl Crawl reference includes SDK.

Crawl a website from a starting URL, following its links to scrape many pages, with depth, page limit and path filters.

> [!NOTE]
>
> Tool ID: `firecrawl_crawl`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'firecrawl_crawl',
  {
    "url": "https://example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute firecrawl_crawl --input '{
  "url": "https://example.com"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": "example"
  }
}
```

Use `deepline describe firecrawl_crawl --json` for the latest machine-readable contract.

## Input reference

Start a crawl job and return its ID for status polling.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.url` | `string` | Yes | — | Starting URL to crawl |
| `payload.maxDiscoveryDepth` | `integer` | No | — | Max link depth to discover |
| `payload.limit` | `integer` | No | — | Max pages to crawl (default 10000) |
| `payload.includePaths` | `array` | No | — | Only crawl URLs matching these glob patterns |
| `payload.excludePaths` | `array` | No | — | Skip URLs matching these glob patterns |
| `payload.scrapeOptions` | `object` | No | — | Scrape options for each page |
| `payload.webhook` | `object` | No | — | Webhook for completion notification |
| `payload.prompt` | `string` | No | — | Natural language crawl guidance |
| `payload.sitemap` | `"skip" \| "include" \| "only"` | No | — | Sitemap handling (default "include") Allowed: `skip`, `include`, `only`. |
| `payload.ignoreQueryParameters` | `boolean` | No | — | Ignore query parameters in URLs (default false) |
| `payload.regexOnFullURL` | `boolean` | No | — | Apply regex patterns to full URL (default false) |
| `payload.crawlEntireDomain` | `boolean` | No | — | Crawl the entire domain (default false) |
| `payload.allowExternalLinks` | `boolean` | No | — | Follow external links (default false) |
| `payload.allowSubdomains` | `boolean` | No | — | Follow subdomain links (default false) |
| `payload.delay` | `number` | No | — | Seconds to wait between scrapes |
| `payload.maxConcurrency` | `integer` | No | — | Max concurrent scrapes |
| `payload.zeroDataRetention` | `boolean` | No | — | Do not store any data (default false) |
| `payload.timeoutMs` | `integer` | No | — | Deprecated compatibility field. Start actions now return immediately. Use the matching status action to poll. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe firecrawl_crawl --json`.

## Output reference

Crawl job result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | No | — | — |
| `result.data.status` | `string` | Yes | — | — |
| `result.data.total` | `number` | No | — | — |
| `result.data.completed` | `number` | No | — | — |
| `result.data.expiresAt` | `string` | No | — | — |
| `result.data.next` | `string` | No | — | — |
| `result.data.data` | `array` | No | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Crawl job result.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "total": {
            "type": "number"
          },
          "completed": {
            "type": "number"
          },
          "expiresAt": {
            "type": "string"
          },
          "next": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            }
          }
        },
        "required": [
          "status"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_page` (per page).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [Firecrawl provider guide](https://deepline.com/docs/providers/firecrawl/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.