batch_scrape
Scrape 2-50 URLs in a single call with sync or async execution, returning structured data in multiple formats like JSON, HTML, markdown, or text.
Instructions
Use this to scrape 2-50 URLs in one call - product pages, news articles, competitor pages. Never loop scrape over a URL list. mode:"sync" returns results directly for up to ~25 URLs; mode:"async" with a webhook for larger batches, then get_batch_results. Not for one URL (scrape) or for discovering URLs (map_site). Cost: 5 credits. Example: batch_scrape({urls: ["https://a.com","https://b.com"], formats: ["json"], maxConcurrency: 5})
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Processing mode: sync (wait) or async (background) | sync |
| urls | Yes | Array of URLs or URL objects to scrape | |
| formats | No | Output formats for scraped content | |
| webhook | No | Webhook configuration for async job notifications | |
| pageSize | No | Number of results per page | |
| jobOptions | No | Job management options for async processing | |
| redact_pii | No | Redact personal data from the text this call returns, before it reaches your context window. true means the free regex pass over EMAIL, PHONE, FINANCIAL and SECRET. The result carries redaction:{entities,count}. Default: off | |
| user_agent | No | Override the outbound User-Agent. CrawlForge identifies itself honestly by default; use this only for targets you have your own agreement with. | |
| includeFailed | No | Include failed URLs in results | |
| maxConcurrency | No | Maximum concurrent scraping requests | |
| respect_robots | No | Respect the target site's robots.txt (default: true). Setting this to false is honoured, returns a warning in the response, and is recorded against your API key — it is your decision, not a silent default. | |
| includeMetadata | No | Include page metadata in results | |
| extractionSchema | No | Schema for structured data extraction from each URL | |
| max_inline_chars | No | Largest result to return inline, in characters of its JSON. Over it, the call returns a preview plus a result_handle for read_result instead of the whole result (default 40,000; env CRAWLFORGE_MAX_INLINE_CHARS) | |
| delayBetweenRequests | No | Delay in milliseconds between requests |