Skip to content
LlamaIndex API Docs
Get started
API Reference
Beta
Batch

List Batch Jobs

beta.batch.list(BatchListParams**kwargs) -> SyncPaginatedBatchItems[BatchListResponse]
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.

ParametersExpand Collapse
directory_id: Optional[str]

Filter by directory ID

job_type: Optional[Literal["parse", "extract", "classify"]]

Type of batch processing operation.

Accepts one of the following:
"parse"
"extract"
"classify"
limit: Optional[int]

Maximum number of jobs to return

maximum1000
minimum1
offset: Optional[int]

Number of jobs to skip for pagination

minimum0
organization_id: Optional[str]
project_id: Optional[str]
status: Optional[Literal["pending", "running", "dispatched", 3 more]]

Status of a batch processing job.

Accepts one of the following:
"pending"
"running"
"dispatched"
"completed"
"failed"
"cancelled"
ReturnsExpand Collapse
class BatchListResponse: …

Response schema for a batch processing job.

id: str

Unique identifier for the batch job

job_type: Literal["parse", "extract", "classify"]

Type of processing operation

Accepts one of the following:
"parse"
"extract"
"classify"
project_id: str

Project this job belongs to

status: Literal["pending", "running", "dispatched", 3 more]

Current status of the job

Accepts one of the following:
"pending"
"running"
"dispatched"
"completed"
"failed"
"cancelled"
total_items: int

Total number of items in the job

completed_at: Optional[datetime]

Timestamp when job completed

formatdate-time
created_at: Optional[datetime]

Creation datetime

formatdate-time
directory_id: Optional[str]

Directory being processed

effective_at: Optional[datetime]
error_message: Optional[str]

Error message for the latest job attempt, if any.

failed_items: Optional[int]

Number of items that failed processing

job_record_id: Optional[str]

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

processed_items: Optional[int]

Number of items processed so far

skipped_items: Optional[int]

Number of items skipped (already processed or size limit)

started_at: Optional[datetime]

Timestamp when job processing started

formatdate-time
updated_at: Optional[datetime]

Update datetime

formatdate-time
workflow_id: Optional[str]

Temporal workflow ID for this batch job

List Batch Jobs

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.beta.batch.list()
page = page.items[0]
print(page.id)
{
  "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
}