firecrawl_check_batch_status
Monitor the progress and results of a web scraping batch job by providing its ID to track completion status and retrieve extracted data.
Instructions
Check the status of a batch scraping job.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Batch job ID to check |
Implementation Reference
- src/index.ts:1032-1066 (handler)Handler logic for the firecrawl_check_batch_status tool. Checks the status of a batch scraping operation by looking up the operation ID in the batchOperations map and returns formatted status information.
case 'firecrawl_check_batch_status': { if (!isStatusCheckOptions(args)) { throw new Error( 'Invalid arguments for firecrawl_check_batch_status' ); } const operation = batchOperations.get(args.id); if (!operation) { return { content: [ { type: 'text', text: `No batch operation found with ID: ${args.id}`, }, ], isError: true, }; } const status = `Batch Status: Status: ${operation.status} Progress: ${operation.progress.completed}/${operation.progress.total} ${operation.error ? `Error: ${operation.error}` : ''} ${ operation.result ? `Results: ${JSON.stringify(operation.result, null, 2)}` : '' }`; return { content: [{ type: 'text', text: status }], isError: false, }; } - src/index.ts:378-391 (schema)Tool schema definition including name, description, and input schema requiring a batch job ID.
const CHECK_BATCH_STATUS_TOOL: Tool = { name: 'firecrawl_check_batch_status', description: 'Check the status of a batch scraping job.', inputSchema: { type: 'object', properties: { id: { type: 'string', description: 'Batch job ID to check', }, }, required: ['id'], }, }; - src/index.ts:862-874 (registration)Registration of all tools including CHECK_BATCH_STATUS_TOOL in the ListToolsRequest handler.
server.setRequestHandler(ListToolsRequestSchema, async () => ({ tools: [ SCRAPE_TOOL, MAP_TOOL, CRAWL_TOOL, BATCH_SCRAPE_TOOL, CHECK_BATCH_STATUS_TOOL, CHECK_CRAWL_STATUS_TOOL, SEARCH_TOOL, EXTRACT_TOOL, DEEP_RESEARCH_TOOL, ], })); - src/index.ts:649-656 (helper)Type guard helper function to validate input arguments for status check tools.
function isStatusCheckOptions(args: unknown): args is StatusCheckOptions { return ( typeof args === 'object' && args !== null && 'id' in args && typeof (args as { id: unknown }).id === 'string' ); } - src/index.ts:557-559 (helper)Type interface for status check options used by the handler.
interface StatusCheckOptions { id: string; }