Skip to main content
POST
/
v1
/
batch-jobs
/
{batchJobId}
/
cancel
Cancel a batch job
curl --request POST \
  --url https://gateway.app.clavata.ai:8443/v1/batch-jobs/{batchJobId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "batchJobId": "<string>",
  "state": "BATCH_JOB_STATE_UNSPECIFIED",
  "error": {
    "errorCode": "BATCH_JOB_ERROR_UNSPECIFIED",
    "errorMessage": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
batchJobId
string
required

The ID of the batch job to cancel

Body

application/json

The body is of type object.

Response

A successful response.

​
batchJobId
string
​
state
enum<string>
default:BATCH_JOB_STATE_UNSPECIFIED
Available options:
BATCH_JOB_STATE_UNSPECIFIED,
BATCH_JOB_STATE_ERROR,
BATCH_JOB_STATE_INITIALIZED,
BATCH_JOB_STATE_QUEUED,
BATCH_JOB_STATE_PREPROCESSING,
BATCH_JOB_STATE_PREPROCESSED,
BATCH_JOB_STATE_SUBMITTED,
BATCH_JOB_STATE_POSTPROCESSING,
BATCH_JOB_STATE_POSTPROCESSED,
BATCH_JOB_STATE_COMPLETED,
BATCH_JOB_STATE_CANCELLED
​
error
object