Overview
Key Improvements
-
Faster by default: Requests are cached with
maxAge
defaulting to 2 days, and sensible defaults likeblockAds
,skipTlsVerification
, andremoveBase64Images
are enabled. -
New summary format: You can now specify
"summary"
as a format to directly receive a concise summary of the page content. -
Updated JSON extraction: JSON extraction and change tracking now use an object format:
{ type: "json", prompt, schema }
. The old"extract"
format has been renamed to"json"
. -
Enhanced screenshot options: Use the object form:
{ type: "screenshot", fullPage, quality, viewport }
. -
New search sources: Search across
"news"
and"images"
in addition to web results by setting thesources
parameter. -
Smart crawling with prompts: Pass a natural-language
prompt
to crawl and the system derives paths/limits automatically. Use the new /crawl/params-preview endpoint to inspect the derived options before starting a job.
Quick migration checklist
- Replace v1 client usage with v2 clients:
- JS:
const firecrawl = new Firecrawl({ apiKey: 'fc-YOUR-API-KEY' })
- Python:
firecrawl = Firecrawl(api_key='fc-YOUR-API-KEY')
- API: use the new
https://api.firecrawl.dev/v2/
endpoints.
- JS:
- Update formats:
- Use
"summary"
where needed - JSON mode: Use
{ type: "json", prompt, schema }
for JSON extraction - Screenshot and Screenshot@fullPage: Use screenshot object format when specifying options
- Use
- Adopt standardized async flows in the SDKs:
- Crawls:
startCrawl
+getCrawlStatus
(orcrawl
waiter) - Batch:
startBatchScrape
+getBatchScrapeStatus
(orbatchScrape
waiter) - Extract:
startExtract
+getExtractStatus
(orextract
waiter)
- Crawls:
- Crawl options mapping (see below)
- Check crawl
prompt
with/crawl/params-preview
SDK surface (v2)
JS/TS
Method name changes (v1 → v2)
Scrape, Search, and Mapv1 (FirecrawlApp) | v2 (Firecrawl) |
---|---|
scrapeUrl(url, ...) | scrape(url, options?) |
search(query, ...) | search(query, options?) |
mapUrl(url, ...) | map(url, options?) |
v1 | v2 |
---|---|
crawlUrl(url, ...) | crawl(url, options?) (waiter) |
asyncCrawlUrl(url, ...) | startCrawl(url, options?) |
checkCrawlStatus(id, ...) | getCrawlStatus(id) |
cancelCrawl(id) | cancelCrawl(id) |
checkCrawlErrors(id) | getCrawlErrors(id) |
v1 | v2 |
---|---|
batchScrapeUrls(urls, ...) | batchScrape(urls, opts?) (waiter) |
asyncBatchScrapeUrls(urls, ...) | startBatchScrape(urls, opts?) |
checkBatchScrapeStatus(id, ...) | getBatchScrapeStatus(id) |
checkBatchScrapeErrors(id) | getBatchScrapeErrors(id) |
v1 | v2 |
---|---|
extract(urls?, params?) | extract(args) |
asyncExtract(urls, params?) | startExtract(args) |
getExtractStatus(id) | getExtractStatus(id) |
v1 | v2 |
---|---|
generateLLMsText(...) | (not in v2 SDK) |
checkGenerateLLMsTextStatus(id) | (not in v2 SDK) |
crawlUrlAndWatch(...) | watcher(jobId, ...) |
batchScrapeUrlsAndWatch(...) | watcher(jobId, ...) |
Python (sync)
Method name changes (v1 → v2)
Scrape, Search, and Mapv1 | v2 |
---|---|
scrape_url(...) | scrape(...) |
search(...) | search(...) |
map_url(...) | map(...) |
v1 | v2 |
---|---|
crawl_url(...) | crawl(...) (waiter) |
async_crawl_url(...) | start_crawl(...) |
check_crawl_status(...) | get_crawl_status(...) |
cancel_crawl(...) | cancel_crawl(...) |
v1 | v2 |
---|---|
batch_scrape_urls(...) | batch_scrape(...) (waiter) |
async_batch_scrape_urls(...) | start_batch_scrape(...) |
get_batch_scrape_status(...) | get_batch_scrape_status(...) |
get_batch_scrape_errors(...) | get_batch_scrape_errors(...) |
v1 | v2 |
---|---|
extract(...) | extract(...) |
start_extract(...) | start_extract(...) |
get_extract_status(...) | get_extract_status(...) |
v1 | v2 |
---|---|
generate_llms_text(...) | (not in v2 SDK) |
get_generate_llms_text_status(...) | (not in v2 SDK) |
watch_crawl(...) | watcher(job_id, ...) |
Python (async)
AsyncFirecrawl
mirrors the same methods (all awaitable).
Formats and scrape options
- Use string formats for basics:
"markdown"
,"html"
,"rawHtml"
,"links"
,"summary"
. - Instead of
parsePDF
useparsers: [ { "type": "pdf" } | "pdf" ]
. - Use object formats for JSON, change tracking, and screenshots:
JSON format
Screenshot format
Crawl options mapping (v1 → v2)
v1 | v2 |
---|---|
allowBackwardCrawling | (removed) use crawlEntireDomain |
maxDepth | (removed) use maxDiscoveryDepth |
ignoreSitemap (bool) | sitemap (e.g., "only" , "skip" , or "include" ) |
(none) | prompt |