Skip to content
Framework Docs

List Split Jobs

SplitListPage beta().split().list(SplitListParamsparams = SplitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/beta/split/jobs

List document split jobs.

ParametersExpand Collapse
SplitListParams 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
Optional<String> pageToken
Optional<String> projectId
Optional<Status> status

Filter by job status (pending, processing, completed, failed, cancelled)

PENDING("pending")
PROCESSING("processing")
COMPLETED("completed")
FAILED("failed")
CANCELLED("cancelled")
ReturnsExpand Collapse
class SplitListResponse:

Beta response — uses nested document_input object.

String id

Unique identifier for the split job.

List<SplitCategory> categories

Categories used for splitting.

String name

Name of the category.

maxLength200
minLength1
Optional<String> description

Optional description of what content belongs in this category.

maxLength2000
minLength1
SplitDocumentInput documentInput

Document that was split.

String type

Type of document input. Valid values are: file_id

String value

Document identifier.

String projectId

Project ID this job belongs to.

String status

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

String userId

User ID who created this job.

Optional<String> configurationId

Split configuration ID used for this job.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time
Optional<String> errorMessage

Error message if the job failed.

Optional<SplitResultResponse> result

Result of a completed split job.

List<SplitSegmentResponse> segments

List of document segments.

String category

Category name this split belongs to.

String confidenceCategory

Categorical confidence level. Valid values are: high, medium, low.

List<long> pages

1-indexed page numbers in this split.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

List Split Jobs

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.beta.split.SplitListPage;
import com.llamacloud_prod.api.models.beta.split.SplitListParams;

public final class Main {
    private Main() {}

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

        SplitListPage page = client.beta().split().list();
    }
}
{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input": {
        "type": "type",
        "value": "value"
      },
      "project_id": "project_id",
      "status": "status",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "result": {
        "segments": [
          {
            "category": "category",
            "confidence_category": "confidence_category",
            "pages": [
              0
            ]
          }
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input": {
        "type": "type",
        "value": "value"
      },
      "project_id": "project_id",
      "status": "status",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "result": {
        "segments": [
          {
            "category": "category",
            "confidence_category": "confidence_category",
            "pages": [
              0
            ]
          }
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}