Cancel a batch's pending and queued rows

Stops rows that have no job yet and cancels queued jobs. Running jobs finish. Succeeded files stay downloadable. Cancelled and failed rows cost nothing.

post/v1/batches/{id}/cancel

Request

  • Base URL: https://thirds.ai
  • URL: https://thirds.ai/v1/batches/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The batch after cancel.

idstring required
template_idstring required
versioninteger required
format'pdf' | 'png' | 'jpeg' | 'webp' required
created_atstring date-time required
state'queued' | 'running' | 'complete' | 'partial' | 'failed' | 'cancelled' required
quoted_creditsinteger required

The row count. Each successful file settles one credit. Failed and cancelled rows cost nothing. There is no bulk discount.

archive_urlstring nullable required

A signed ZIP download link, present once any row has succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.