What is a Job Batch?
A job batch is a collection of related jobs that are processed together. Each batch has:- A unique batch ID
- A batch name (typically derived from the uploaded CSV filename)
- An agent key it’s associated with
- Creation timestamp
Creating a Batch
Using CSV Upload
The simplest way to create a batch is by uploading a CSV file containing multiple cases.Listing Batches
To get a list of all batches for an agent:Parameters:
include_signed_urls
: When set to true, returns secure signed URLs for accessing the original CSV files. These URLs are valid for 1 hour.
## Getting Batch Jobs
To retrieve all jobs in a specific batch:Parameters:
fetch_pdf_from_gcs
: When set to true, includes secure signed URLs for accessing the PDF reports. These URLs are valid for 1 hour.
Downloading Reports
If a job doesn’t have a PDF report URL or you need to regenerate it:Parameters:
force_refresh_report
: When set to true, forces regeneration of the PDF report. This is useful if:- The downloaded PDF is blank or corrupted
- The job was previously in a queued or in-progress state
- You need a fresh copy of the report
- Note: Generated PDF URLs expire after 1 hour
Batch Processing Flow
-
Create Batch
- Upload CSV file or use API endpoints
- System generates batch ID and processes jobs
-
Monitor Progress
- Use
getJobBatches
to list all batches - Use
getBatchJobs
to check individual job statuses
- Use
-
Access Reports
- Download PDF reports using provided GCS URLs
- Generate missing reports using
downloadReport
endpoint
-
Export Results
- Use CSV export functionality for batch results
- Access individual job results through API