Get Batch Job Status

GET/api/v1/beta/batch-processing/{job_id}

Get detailed status of a batch processing job.

Returns current progress, file counts, and estimated completion time.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

job: object { id, job_type, project_id, 14 more }

Response schema for a batch processing job.

id: string

Unique identifier for the batch job

job_type: "parse" or "extract" or "classify"

Type of processing operation

Accepts one of the following:

"parse"

"extract"

"classify"

project_id: string

Project this job belongs to

status: "pending" or "running" or "dispatched" or 3 more

Current status of the job

Accepts one of the following:

"pending"

"running"

"dispatched"

"completed"

"failed"

"cancelled"

total_items: number

Total number of items in the job

completed_at: optional string

Timestamp when job completed

formatdate-time

created_at: optional string

Creation datetime

formatdate-time

directory_id: optional string

Directory being processed

effective_at: optional string

error_message: optional string

Error message for the latest job attempt, if any.

failed_items: optional number

Number of items that failed processing

job_record_id: optional string

The job record ID associated with this status, if any.

processed_items: optional number

Number of items processed so far

skipped_items: optional number

Number of items skipped (already processed or size limit)

started_at: optional string

Timestamp when job processing started

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

workflow_id: optional string

Temporal workflow ID for this batch job

progress_percentage: number

Percentage of items processed (0-100)

maximum100

minimum0

Get Batch Job Status

curl https://api.cloud.llamaindex.ai/api/v1/beta/batch-processing/$JOB_ID \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

{
  "job": {
    "id": "id",
    "job_type": "parse",
    "project_id": "project_id",
    "status": "pending",
    "total_items": 0,
    "completed_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "directory_id": "directory_id",
    "effective_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "failed_items": 0,
    "job_record_id": "job_record_id",
    "processed_items": 0,
    "skipped_items": 0,
    "started_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "workflow_id": "workflow_id"
  },
  "progress_percentage": 0
}

Returns Examples

{
  "job": {
    "id": "id",
    "job_type": "parse",
    "project_id": "project_id",
    "status": "pending",
    "total_items": 0,
    "completed_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "directory_id": "directory_id",
    "effective_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "failed_items": 0,
    "job_record_id": "job_record_id",
    "processed_items": 0,
    "skipped_items": 0,
    "started_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "workflow_id": "workflow_id"
  },
  "progress_percentage": 0
}