Firecrawl icon

Firecrawl

Scrape, crawl, map, search, and extract structured data from websites using Firecrawl API

Scraping → Cancel batch scrape job

AI-generated

Overview

This node operation cancels a batch scrape job using the Firecrawl API. It is useful when you need to stop an ongoing batch scraping process identified by a specific batch ID. For example, if a batch scrape job is running and you want to halt it due to changed requirements or errors, this operation allows you to send a cancellation request to the Firecrawl service.

Use Case Examples

  1. Cancel a batch scrape job by providing its batch ID to stop further scraping tasks.
  2. Use the operation to manage and control batch scraping workflows dynamically.

Properties

Name Meaning
Batch ID ID of the batch scrape job to cancel, used to specify which batch job to stop.
Use Custom Body Flag to indicate whether to use a custom request body in the cancellation request.
Request Options Additional HTTP request options such as batching, SSL handling, proxy, and timeout settings to customize the request behavior.

Output

JSON

  • success - Indicates if the batch scrape job cancellation was successful.
  • message - Additional information or status message returned from the API after cancellation attempt.

Dependencies

  • Firecrawl API key credential for authentication

Troubleshooting

  • Ensure the batch ID provided is correct and corresponds to an active batch scrape job; otherwise, the cancellation will fail.
  • If the API returns authentication errors, verify that the Firecrawl API key credential is correctly configured and valid.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting in request options accordingly.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this should be used cautiously.

Discussion