Skip to main content
DELETE
Cancel a batch

Overview

Stops a running batch: no new URLs are started, and the ones in flight finish. URLs already answered stay readable from GET /batch/{endpoint}/{id} until the batch expires, and are charged as usual. Cancelling a batch that already finished returns its final state.

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Path Parameters

endpoint
enum<string>
required

What every URL is run through. /batch/scrape has its own page.

Available options:
brand,
enrich,
company,
classify,
screenshot,
styleguide
Example:

"enrich"

id
string
required

The id returned when the job was created.

Example:

"crw_9f2c1a7b4e0d4c3a"

Response

Batch cancelled (or already finished).

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