List Parse Jobs

client.parsing.list(?, ?): PaginatedCursor<ParsingListResponse { id, project_id, status, 4 more } >

GET/api/v2/parse

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

ParametersExpand Collapse

query: ParsingListParams { organization_id, page_size, page_token, 2 more }

organization_id?: string | null

page_size?: number | null

Number of items per page

page_token?: string | null

Token for pagination

project_id?: string | null

status?: "PENDING" | "RUNNING" | "COMPLETED" | 2 more | null

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

Accepts one of the following:

"PENDING"

"RUNNING"

"COMPLETED"

"FAILED"

"CANCELLED"

ReturnsExpand Collapse

ParsingListResponse { id, project_id, status, 4 more }

Response schema for a parse job.

id: string

Unique identifier for the parse job

project_id: string

Project this job belongs to

status: "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?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if job failed

name?: string | null

User friendly name

updated_at?: string | null

Update datetime

formatdate-time

List Parse Jobs

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const parsingListResponse of client.parsing.list()) {
  console.log(parsingListResponse.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
}