API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Split

Create Split Job

client.beta.split.create(SplitCreateParams { document_input, organization_id, project_id, 2 more } params, RequestOptionsoptions?): SplitCreateResponse { id, categories, document_input, 8 more }

POST/api/v1/beta/split/jobs

List Split Jobs

client.beta.split.list(SplitListParams { created_at_on_or_after, created_at_on_or_before, job_ids, 5 more } query?, RequestOptionsoptions?): PaginatedCursor<SplitListResponse { id, categories, document_input, 8 more } >

GET/api/v1/beta/split/jobs

Get Split Job

client.beta.split.get(stringsplitJobID, SplitGetParams { organization_id, project_id } query?, RequestOptionsoptions?): SplitGetResponse { id, categories, document_input, 8 more }

GET/api/v1/beta/split/jobs/{split_job_id}

ModelsExpand Collapse

SplitCategory { name, description }

Category definition for document splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

SplitDocumentInput { type, value }

Document input specification for beta API.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

SplitResultResponse { segments }

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: Array<number>

1-indexed page numbers in this split.

SplitSegmentResponse { category, confidence_category, pages }

A segment of the split document.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: Array<number>

1-indexed page numbers in this split.

SplitCreateResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

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

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time

SplitListResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

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

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time

SplitGetResponse { id, categories, document_input, 8 more }

Beta response — uses nested document_input object.

id: string

Unique identifier for the split job.

categories: Array<SplitCategory { name, description } >

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description?: string | null

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

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

user_id: string

User ID who created this job.

configuration_id?: string | null

Split configuration ID used for this job.

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error message if the job failed.

result?: SplitResultResponse { segments } | null

Result of a completed split job.

segments: Array<SplitSegmentResponse { category, confidence_category, pages } >

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: Array<number>

1-indexed page numbers in this split.

updated_at?: string | null

Update datetime

formatdate-time