Skip to content
LlamaIndex OSS Documentation
API Reference
Parsing

List Parse Jobs

parsing.list(ParsingListParams**kwargs) -> SyncPaginatedCursor[ParsingListResponse]
GET/api/v2/parse

List parse jobs for the current project.

Filter by status or creation date range. Results are paginated — use page_token from the response to fetch subsequent pages.

ParametersExpand Collapse
created_at_on_or_after: Optional[Union[str, datetime, null]]

Include jobs created at or after this timestamp (inclusive)

formatdate-time
created_at_on_or_before: Optional[Union[str, datetime, null]]

Include jobs created at or before this timestamp (inclusive)

formatdate-time
job_ids: Optional[SequenceNotStr[str]]

Filter by specific job IDs

organization_id: Optional[str]
page_size: Optional[int]

Number of items per page

page_token: Optional[str]

Token for pagination

project_id: Optional[str]
status: Optional[Literal["PENDING", "RUNNING", "COMPLETED", 2 more]]

Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)

Accepts one of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
ReturnsExpand Collapse
class ParsingListResponse: …

A parse job.

id: str

Unique parse job identifier

project_id: str

Project this job belongs to

status: Literal["PENDING", "RUNNING", "COMPLETED", 2 more]

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

Accepts one of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
error_message: Optional[str]

Error details when status is FAILED

name: Optional[str]

Optional display name for this parse job

tier: Optional[str]

Parsing tier used for this job

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Parse 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.parsing.list()
page = page.items[0]
print(page.id)
{
  "items": [
    {
      "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "Q4 Financial Report",
      "tier": "fast",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "Q4 Financial Report",
      "tier": "fast",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}