List Batch Jobs

GET/api/v1/beta/batch-processing

List all batch processing jobs for a project with optional filtering.

Returns a paginated list of batch jobs with filters for directory, job type, and status. Useful for viewing job history, monitoring progress, and finding specific jobs.

Query ParametersExpand Collapse

directory_id: optional string

Filter by directory ID

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

Type of batch processing operation.

Accepts one of the following:

"parse"

"extract"

"classify"

limit: optional number

Maximum number of jobs to return

maximum1000

minimum1

offset: optional number

Number of jobs to skip for pagination

minimum0

organization_id: optional string

project_id: optional string

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

Status of a batch processing job.

Accepts one of the following:

"pending"

"running"

"dispatched"

"completed"

"failed"

"cancelled"

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

items: array of object { id, job_type, project_id, 14 more }

The list of items.

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

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Batch Jobs

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

{
  "items": [
    {
      "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"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "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"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}