Firecrawl icon

Firecrawl

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

Crawling → Cancel a crawl job

AI-generated

Overview

This node operation allows users to cancel an ongoing crawl job by specifying the crawl job's ID. It is useful in scenarios where a web crawling task needs to be stopped before completion, such as when the crawl parameters were incorrect or the data is no longer needed. For example, if a user started a crawl to extract data from a website but realized the crawl was targeting the wrong pages, they can use this operation to cancel the job promptly.

Use Case Examples

  1. Cancel a crawl job by providing its unique Crawl ID to stop the crawling process immediately.
  2. Use the node to manage crawl jobs dynamically by cancelling unnecessary or erroneous crawls.

Properties

Name Meaning
Crawl ID The unique identifier of the crawl job to cancel, used to specify which crawl job should be stopped.
Use Custom Body Flag to indicate whether to send a custom request body in the cancellation request.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API call behavior.

Output

JSON

  • success - Indicates whether the crawl job cancellation was successful.
  • message - Additional information or status message returned from the API after attempting to cancel the crawl job.

Dependencies

  • Firecrawl API key credential

Troubleshooting

  • Ensure the Crawl ID provided is correct and corresponds to an active crawl job; otherwise, the cancellation will fail.
  • If the API returns an authentication error, verify that the Firecrawl API key credential is correctly configured and has the necessary permissions.
  • Timeout errors may occur if the server is slow to respond; consider increasing the timeout setting in Request Options.
  • If SSL certificate validation fails and you trust the endpoint, enable the 'Ignore SSL Issues' option to bypass SSL errors.

Discussion