Skip to content
Get started

List Parse Jobs

GET/api/v2/parse

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

Query ParametersExpand Collapse
organization_id: optional string
page_size: optional number

Number of items per page

page_token: optional string

Token for pagination

project_id: optional string
status: optional "PENDING" or "RUNNING" or "COMPLETED" or 2 more

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

Accepts one of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
Cookie ParametersExpand Collapse
session: optional string
ReturnsExpand Collapse
items: array of object { id, project_id, status, 4 more }

The list of items.

id: string

Unique identifier for the parse job

project_id: string

Project this job belongs to

status: "PENDING" or "RUNNING" or "COMPLETED" or 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 string

Creation datetime

formatdate-time
error_message: optional string

Error message if job failed

name: optional string

User friendly name

updated_at: optional string

Update datetime

formatdate-time
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 Parse Jobs

curl https://api.cloud.llamaindex.ai/api/v2/parse \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"
{
  "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
}