API Reference

Split

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Split Jobs

split.list(SplitListParams**kwargs) -> SyncPaginatedCursor[SplitListResponse]

GET/api/v1/split/jobs

List document split jobs.

ParametersExpand Collapse

created_at_on_or_after: Optional[Union[str, datetime, null]]

Include items created at or after this timestamp (inclusive)

formatdate-time

created_at_on_or_before: Optional[Union[str, datetime, null]]

Include items created at or before this timestamp (inclusive)

formatdate-time

job_ids: Optional[Sequence[str]]

Filter by specific job IDs

organization_id: Optional[str]

page_size: Optional[int]

page_token: Optional[str]

project_id: Optional[str]

status: Optional[Literal["cancelled", "completed", "failed", 2 more]]

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

One of the following:

"cancelled"

"completed"

"failed"

"pending"

"processing"

ReturnsExpand Collapse

class SplitListResponse: …

A split job.

id: str

Unique identifier for the split job.

categories: List[SplitCategory]

Categories used for splitting.

name: str

Name of the category.

maxLength200

minLength1

description: Optional[str]

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input_type: Literal["file_id", "parse_job_id", "url"]

Whether the input was a file or parse job

One of the following:

"file_id"

"parse_job_id"

"url"

file_input: str

File ID or parse job ID

project_id: str

Project this job belongs to.

status: str

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

user_id: str

User who created this job.

configuration_id: Optional[str]

Split configuration ID used for this job.

created_at: Optional[datetime]

Creation datetime

formatdate-time

error_message: Optional[str]

Error message if the job failed.

result: Optional[SplitResultResponse]

Result of a completed split job.

segments: List[SplitSegmentResponse]

List of document segments.

category: str

Category name this split belongs to.

confidence_category: str

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

pages: List[int]

1-indexed page numbers in this split.

splitting_strategy: Optional[SplittingStrategy]

Strategy used for splitting.

allow_uncategorized: Optional[Literal["forbid", "include", "omit"]]

Controls handling of pages that don’t match any category. ‘include’: pages can be grouped as ‘uncategorized’ and included in results. ‘forbid’: all pages must be assigned to a defined category. ‘omit’: pages can be classified as ‘uncategorized’ but are excluded from results.

One of the following:

"forbid"

"include"

"omit"

custom_instructions: Optional[str]

Free-form guidance for where segment boundaries are placed.

maxLength5000

min_pages_per_split: Optional[int]

Minimum pages per segment. Shorter segments are merged into an adjacent segment; 1 disables merging.

minimum1

transaction_id: Optional[str]

Idempotency key scoped to the project, if one was provided.

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Split Jobs

Python

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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.split.list()
page = page.items[0]
print(page.id)

200 example

{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input_type": "file_id",
      "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "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
            ]
          }
        ]
      },
      "splitting_strategy": {
        "allow_uncategorized": "forbid",
        "custom_instructions": "Start a new segment at every signature page.",
        "min_pages_per_split": 1
      },
      "transaction_id": "transaction_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input_type": "file_id",
      "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "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
            ]
          }
        ]
      },
      "splitting_strategy": {
        "allow_uncategorized": "forbid",
        "custom_instructions": "Start a new segment at every signature page.",
        "min_pages_per_split": 1
      },
      "transaction_id": "transaction_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}