Skip to content
Get started

List Parse Jobs

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

List parse jobs for the current project with optional status filtering and pagination.

ParametersExpand Collapse
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:

Response schema for a parse job.

id: str

Unique identifier for the parse job

project_id: str

Project this job belongs to

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

Current status of the job (e.g., pending, running, completed, failed, cancelled)

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

Creation datetime

formatdate-time
error_message: Optional[str]

Error message if job failed

name: Optional[str]

User friendly name

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": "id",
      "project_id": "project_id",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "project_id": "project_id",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}