Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/firecrawl/firecrawl/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint

DELETE /v1/batch/scrape/{id}

Authentication

This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string
required
The ID of the batch scrape job to cancel (UUID format)

Response

success
boolean
Indicates whether the batch scrape job was successfully cancelled
message
string
Confirmation message

Examples

curl -X DELETE https://api.firecrawl.dev/v1/batch/scrape/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer YOUR_API_KEY'

Success Response

{
  "success": true,
  "message": "Batch scrape job successfully cancelled."
}

Error Responses

404
object
Not Found - Batch scrape job not found.
{
  "error": "Batch scrape job not found."
}
500
object
Server Error - An unexpected error occurred on the server.
{
  "error": "An unexpected error occurred on the server."
}