TRtrainloop
public-api

Public Cancel Batch

Changed on

Stop a batch. In-flight items finish; nothing new starts. Outputs already delivered stay delivered.

post/v1/batches/{batch_id}/cancel

Request

  • Base URL
    https://api.trainloop.ai (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

batch_idstring uuid required

Headers

authorizationstring nullable

Response

Successful Response

idstring uuid required
pipelinestring required
status'queued' | 'dispatched' | 'running' | 'completed' | 'completed_with_errors' | 'failed' | 'cancelled' required
connection_idstring uuid required
input_pathstring required
output_pathstring required
optionsobject required
item_totalinteger required
item_doneinteger required
item_skippedinteger required
item_failedinteger required
errorstring required
created_atstring date-time required
updated_atstring date-time required
started_atstring date-time nullable required
finished_atstring date-time nullable required

Changes