Skip to content
Developer Documentation
API Reference

Split

Create Split Job
split.create(SplitCreateParams**kwargs) -> SplitCreateResponse
POST/api/v1/split/jobs
List Split Jobs
split.list(SplitListParams**kwargs) -> SyncPaginatedCursor[SplitListResponse]
GET/api/v1/split/jobs
Get Split Job
split.get(strsplit_job_id, SplitGetParams**kwargs) -> SplitGetResponse
GET/api/v1/split/jobs/{split_job_id}
Delete Split Job
split.delete(strsplit_job_id, SplitDeleteParams**kwargs) -> object
DELETE/api/v1/split/jobs/{split_job_id}
Cancel Split Job
split.cancel(strsplit_job_id, SplitCancelParams**kwargs) -> SplitCancelResponse
POST/api/v1/split/jobs/{split_job_id}/cancel
ModelsExpand Collapse
class SplitCreateResponse: …

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
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
class SplitGetResponse: …

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
class SplitCancelResponse: …

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
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/