Firecrawl: Crawl

Crawling a website by following links from a starting URL.

Tool ID: firecrawl_crawl

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

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

deepline tools execute firecrawl_crawl --input '{
  "url": "https://example.com"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "status": "example"
  }
}

Use deepline tools get 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.

This input schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get 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).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation