Skip to main content
DELETE
Cancel a batch

Overview

Stops a batch that is pending or running. Pages already scraped stay readable through GET /batch/scrape/{id} until the batch expires, and are billed on the next status call as usual. Cancelling a finished batch returns its final state. Free.

Example request

cURL

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Path Parameters

id
string
required

The crawl id returned by POST /crawl.

Example:

"crw_9f2c1a7b4e0d4c3a8b1e5f7d2c9a0b3e"

Response

Batch cancelled, or already finished.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required