Skip to content
Get started

Split

Create Split Job
POST/api/v1/beta/split/jobs
List Split Jobs
GET/api/v1/beta/split/jobs
Get Split Job
GET/api/v1/beta/split/jobs/{split_job_id}
ModelsExpand Collapse
SplitCategory = object { name, description }

Category definition for document splitting.

name: string

Name of the category.

maxLength200
minLength1
description: optional string

Optional description of what content belongs in this category.

maxLength2000
minLength1
SplitDocumentInput = object { type, value }

Document input specification.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

SplitResultResponse = object { segments }

Result of a completed split job.

segments: array of 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 of number

1-indexed page numbers in this split.

SplitSegmentResponse = object { 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 of number

1-indexed page numbers in this split.