Cancel a batch scrape (Firecrawl)
Cancels the batch. Answers `409` when it already finished, which the SDKs treat as nothing to cancel.
DELETE
/compat/firecrawl/v1/batch/scrape/{id}
Cancels the batch. Answers `409` when it already finished, which the SDKs treat as nothing to cancel.
Authentication
Bearer Token (b3os_sk_ API key or b3os_pat_ token)
Path Parameters
id
string
required
path
The job ID B3OS returned (a `crawl_`, `batch_` or `job_` ID; Firecrawl clients treat it as opaque).
Responses
200
Canceled.
application/jsonsuccess
boolean
Enum:
truestatus
string
REQUIRED
Enum:
cancelled
401
Missing or invalid B3OS key (`unauthorized`). Firecrawl `fc-` keys are not accepted.
404
No such job in this project (`crawl_not_found`, `batch_not_found`, `job_not_found`).
409
The job already finished (`job_already_finished`).
500
Something failed inside B3OS (`internal`).
curl -X DELETE 'https://beta-api.b3os.org/compat/firecrawl/v1/batch/scrape/string' \ -H 'Authorization: Bearer YOUR_API_TOKEN'const response = await fetch('https://beta-api.b3os.org/compat/firecrawl/v1/batch/scrape/string', { method: 'DELETE', headers: { "Authorization": "Bearer YOUR_API_TOKEN" }});const data = await response.json();console.log(data);import requestsheaders = { 'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.delete('https://beta-api.b3os.org/compat/firecrawl/v1/batch/scrape/string', headers=headers)print(response.json())
200
Response
{ "success": true, "status": "cancelled"}API Playground
Try this endpoint
DELETE
/compat/firecrawl/v1/batch/scrape/{id}