Skip to content

Cancel a batch job

DELETE /v1/jobs/{batch_id}

https://api.voygr.tech/v1/jobs/{batch_id}

Open in playground

Overview

Request cancellation of a queued or running job (any type). Rows already processed are kept, billed, and downloadable; unprocessed rows are not charged.

Authentication

  • API key in header X-API-Key: Your customer API key (pk_live_...), sent on every request. Self-serve at https://api.voygr.tech/checkout.

Parameters

NameLocationRequiredTypeDescription and constraints
batch_idpathrequiredstring

Responses

200

Successful Response

application/json

Schema: ValidationJobDeleteResponse

422

Validation Error

application/json

Schema: HTTPValidationError

Schemas

ValidationJobDeleteResponse

Type: object

FieldTypeRequiredDescription and constraints
batch_idstringrequired
statusstringrequiredone of queued, running, completed, failed, cancelled

HTTPValidationError

Type: object

FieldTypeRequiredDescription and constraints
detailarray of ValidationErroroptional

ValidationError

Type: object

FieldTypeRequiredDescription and constraints
locarray of (string | integer)required
msgstringrequired
typestringrequired
inputanyoptional
ctxobjectoptional