MImistral
batch

Cancel Batch Job

Changed on

Request the cancellation of a batch job.

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

Request

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

Changes

  • ff8a7389b7a4Revision changes
    • info

      the response property const value batch was added for the status

    • info

      removed the batch enum value from the response property for the response status

  • 37659aafcad6Revision changes
    • info

      added the optional property to the response with the status