Skip to content
LlamaIndex API Docs
Framework Docs
API Reference
Parsing

List Parse Jobs

ParsingListPage parsing().list(ParsingListParamsparams = ParsingListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
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
ParsingListParams params
Optional<LocalDateTime> createdAtOnOrAfter

Include items created at or after this timestamp (inclusive)

formatdate-time
Optional<LocalDateTime> createdAtOnOrBefore

Include items created at or before this timestamp (inclusive)

formatdate-time
Optional<List<String>> jobIds

Filter by specific job IDs

Optional<String> organizationId
Optional<Long> pageSize

Number of items per page

Optional<String> pageToken

Token for pagination

Optional<String> projectId
Optional<Status> status

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

CANCELLED("CANCELLED")
COMPLETED("COMPLETED")
FAILED("FAILED")
PENDING("PENDING")
RUNNING("RUNNING")
ReturnsExpand Collapse
class ParsingListResponse:

A parse job.

String id

Unique parse job identifier

String projectId

Project this job belongs to

Status status

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

One of the following:
CANCELLED("CANCELLED")
COMPLETED("COMPLETED")
FAILED("FAILED")
PENDING("PENDING")
RUNNING("RUNNING")
Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time
Optional<String> errorMessage

Error details when status is FAILED

Optional<String> name

Optional display name for this parse job

Optional<String> tier

Parsing tier used for this job

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time
Optional<UserMetadata> userMetadata

Key/value tags associated with this job.

List Parse Jobs

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.parsing.ParsingListPage;
import ai.llamaindex.llamacloud.models.parsing.ParsingListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        ParsingListPage page = client.parsing().list();
    }
}
{
  "items": [
    {
      "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "CANCELLED",
      "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",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "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": "CANCELLED",
      "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",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}