DELETE /v1/jobs/{batch_id}
https://api.voygr.tech/v1/jobs/{batch_id}
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
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
batch_id | path | required | string |
Responses
200
Successful Response
application/json
Schema: ValidationJobDeleteResponse
422
Validation Error
application/json
Schema: HTTPValidationError
Schemas
ValidationJobDeleteResponse
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
batch_id | string | required | |
status | string | required | one of queued, running, completed, failed, cancelled |
HTTPValidationError
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
detail | array of ValidationError | optional |
ValidationError
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
loc | array of (string | integer) | required | |
msg | string | required | |
type | string | required | |
input | any | optional | |
ctx | object | optional |
On this page
