Skip to content
Get started

Batch

Create Batch Job
client.beta.batch.create(BatchCreateParams { job_config, organization_id, project_id, 5 more } params, RequestOptionsoptions?): BatchCreateResponse { id, job_type, project_id, 14 more }
POST/api/v1/beta/batch-processing
List Batch Jobs
client.beta.batch.list(BatchListParams { directory_id, job_type, limit, 4 more } query?, RequestOptionsoptions?): PaginatedBatchItems<BatchListResponse { id, job_type, project_id, 14 more } >
GET/api/v1/beta/batch-processing
Get Batch Job Status
client.beta.batch.getStatus(stringjobID, BatchGetStatusParams { organization_id, project_id } query?, RequestOptionsoptions?): BatchGetStatusResponse { job, progress_percentage }
GET/api/v1/beta/batch-processing/{job_id}
Cancel Batch Job
client.beta.batch.cancel(stringjobID, BatchCancelParams { organization_id, project_id, reason, temporalNamespace } params, RequestOptionsoptions?): BatchCancelResponse { job_id, message, processed_items, status }
POST/api/v1/beta/batch-processing/{job_id}/cancel

BatchJob Items

List Batch Job Items
client.beta.batch.jobItems.list(stringjobID, JobItemListParams { limit, offset, organization_id, 2 more } query?, RequestOptionsoptions?): PaginatedBatchItems<JobItemListResponse { item_id, item_name, status, 7 more } >
GET/api/v1/beta/batch-processing/{job_id}/items
Get Item Processing Results
client.beta.batch.jobItems.getProcessingResults(stringitemID, JobItemGetProcessingResultsParams { job_type, organization_id, project_id } query?, RequestOptionsoptions?): JobItemGetProcessingResultsResponse { item_id, item_name, processing_results }
GET/api/v1/beta/batch-processing/items/{item_id}/processing-results