Sign in
batch

Cancel Batch Job

Request the cancellation of a batch job.

post/v1/batch/jobs/{job_id}/cancel

Path parameters

job_idstring uuid required

Response

OK

idstring required
object'batch'
input_filesstring[] required
metadataobject nullable
endpointstring required
modelstring nullable
agent_idstring nullable
output_filestring uuid nullable
error_filestring uuid nullable
outputsobject[] nullable
status'QUEUED' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'TIMEOUT_EXCEEDED' | 'CANCELLATION_REQUESTED' | 'CANCELLED' required
created_atinteger required
total_requestsinteger required
completed_requestsinteger required
succeeded_requestsinteger required
failed_requestsinteger required
started_atinteger nullable
completed_atinteger nullable