Start Crawl Job
crawlStart a bounded local web-scraping job that respects robots.txt and returns a job ID immediately.
Instructions
Start a bounded Firecrawl Local Crawl Job. Respect for robots.txt is mandatory. Returns immediately with a crawlId.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"url": "<url>"
},
"name": "crawl"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| limit | No | ||
| delayMs | No | ||
| formats | No | ||
| sitemap | No | include | |
| timeoutMs | No | ||
| waitForMs | No | ||
| excludePaths | No | ||
| includePaths | No | ||
| maxConcurrency | No | ||
| allowSubdomains | No | ||
| onlyMainContent | No | ||
| crawlEntireDomain | No | ||
| maxDiscoveryDepth | No | ||
| allowExternalLinks | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pages | Yes | ||
| total | Yes | ||
| errors | Yes | ||
| offset | Yes | ||
| status | Yes | ||
| crawlId | Yes | ||
| hasMore | Yes | ||
| partial | Yes | ||
| returned | Yes | ||
| completed | Yes | ||
| expiresAt | No | ||
| artifactId | No | ||
| providerJobId | No |