> ## 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: Batch Scrape

> Scrape a known list of page URLs in parallel as one asynchronous job, returning content as Markdown or structured data. Firecrawl Batch Scrape reference.

Scrape a known list of page URLs in parallel as one asynchronous job, returning content as Markdown or structured data.

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

## 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_batch_scrape',
  {
    "urls": [
      "https://example.com"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute firecrawl_batch_scrape --input '{
  "urls": [
    "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_batch_scrape --json` for the latest machine-readable contract.

## Input reference

Start a batch scrape job and return its ID for status polling.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.urls` | `array` | Yes | — | URLs to scrape |
| `payload.scrapeOptions` | `object` | No | — | Scrape options applied to all URLs |
| `payload.webhook` | `object` | No | — | Webhook for completion notification |
| `payload.maxConcurrency` | `integer` | No | — | Max concurrent scrapes |
| `payload.ignoreInvalidURLs` | `boolean` | No | — | Skip invalid URLs instead of failing (default true) |
| `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. |
| `payload.maxDataBytes` | `integer` | No | — | Maximum bytes returned for batch page data. Large fields are clipped with an explicit marker. default 6 MiB. Minimum: 65536. Maximum: 8388608. |

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

## Output reference

Batch scrape 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.next` | `string` | No | — | — |
| `result.data.data` | `array` | No | — | — |
| `result.data.dataTruncated` | `object` | No | — | — |
| `result.data.dataTruncated.maxDataBytes` | `number` | Yes | — | — |
| `result.data.dataTruncated.truncatedFields` | `number` | Yes | — | — |
| `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": "Batch scrape job result.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "total": {
            "type": "number"
          },
          "completed": {
            "type": "number"
          },
          "next": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            }
          },
          "dataTruncated": {
            "type": "object",
            "properties": {
              "maxDataBytes": {
                "type": "number"
              },
              "truncatedFields": {
                "type": "number"
              }
            },
            "required": [
              "maxDataBytes",
              "truncatedFields"
            ],
            "additionalProperties": false
          }
        },
        "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.