Skip to main content
DELETE
Cancel a Batch

Overview

Cancels a batch that is currently pending or running. Credits reserved for items that have not yet started are refunded automatically. Items already being processed will complete normally.

Response

Items that were already running when you cancelled will finish processing and consume their credits. Only pending items are cancelled and refunded.

Errors

Already terminal:

Retry Failed Batch Scrapes

Re-queue failed items instead of cancelling

Get Batch Status

Check current status before cancelling

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batchId
string<uuid>
required

The batch ID to cancel

Response

Batch cancelled successfully

status
enum<string>
Available options:
cancelled
cancelledItems
integer

Number of pending items that were stopped

creditsRefunded
integer

Credits returned to your balance