About the Batch Processing API
An API to run and manage batch processing jobs against multiple files.
Jobs
Create Job
Create a new batch or training job
List Jobs
Retrieve a cursor-paginated list of jobs with optional filters
Get Job
Retrieve details of a specific job by ID
Retry Job
Retry a failed or cancelled job
Pause an ongoing batch job
Resume Job
Resume a paused or interrupted job
Delete Job
Permanently delete a job and its associated data
Cancel Job
Cancel a running or pending job
Get Queue Depths
Retrieve global queue depths grouped by pipeline type
I/O
List Inputs
Retrieve a cursor-paginated list of inputs for a specific job
List Outputs
Retrieve a cursor-paginated list of outputs for a specific job
List Inputs With Progress
Tracked inputs paired with their latest progress entry
Get Inputs Progress Counts
Per-status counts of tracked inputs for a job
Get Inputs Progress Traces
Bucketed cumulative file and per-kind item counters across the job lifetime
Validate Prospective Inputs
Validate the inputs for a prospective job without creating a job
Was this page helpful?