API Reference

Split

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Split Job

SplitCreateResponse Split.Create(SplitCreateParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/split/jobs

Create a document split job.

ParametersExpand Collapse

SplitCreateParams parameters

required string fileInput

Body param: File ID or parse job ID

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

Configuration? configuration

Body param: Split configuration with categories and splitting strategy.

required IReadOnlyList<SplitCategory> Categories

Categories to split documents into.

required string Name

Name of the category.

maxLength200

minLength1

string? Description

Optional description of what content belongs in this category.

maxLength2000

minLength1

SplittingStrategy SplittingStrategy

Strategy for splitting documents.

AllowUncategorized AllowUncategorized

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"Forbid

"include"Include

"omit"Omit

string? CustomInstructions

Free-form guidance for where segment boundaries are placed.

maxLength5000

Long MinPagesPerSplit

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

minimum1

string? configurationID

Body param: Saved configuration ID

string? transactionID

Body param: Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored.

maxLength255

IReadOnlyList<string>? webhookConfigurationIds

Body param: IDs of saved webhook configurations to notify for this job.

IReadOnlyList<WebhookConfiguration>? webhookConfigurations

Body param: Outbound webhook endpoints to notify on job status changes

IReadOnlyList<WebhookEvent>? WebhookEvents

Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.

One of the following:

"batch.cancelled"BatchCancelled

"batch.error"BatchError

"batch.pending"BatchPending

"batch.running"BatchRunning

"batch.success"BatchSuccess

"classify.cancelled"ClassifyCancelled

"classify.error"ClassifyError

"classify.partial_success"ClassifyPartialSuccess

"classify.pending"ClassifyPending

"classify.running"ClassifyRunning

"classify.success"ClassifySuccess

"extract.cancelled"ExtractCancelled

"extract.error"ExtractError

"extract.partial_success"ExtractPartialSuccess

"extract.pending"ExtractPending

"extract.success"ExtractSuccess

"parse.cancelled"ParseCancelled

"parse.error"ParseError

"parse.partial_success"ParsePartialSuccess

"parse.pending"ParsePending

"parse.running"ParseRunning

"parse.success"ParseSuccess

"sheets.cancelled"SheetsCancelled

"sheets.error"SheetsError

"sheets.partial_success"SheetsPartialSuccess

"sheets.pending"SheetsPending

"sheets.success"SheetsSuccess

"split.cancelled"SplitCancelled

"split.error"SplitError

"split.pending"SplitPending

"split.processing"SplitProcessing

"split.success"SplitSuccess

"unmapped_event"UnmappedEvent

IReadOnlyDictionary<string, string>? WebhookHeaders

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

string? WebhookOutputFormat

Response format sent to the webhook: ‘string’ (default) or ‘json’

string? WebhookSigningSecret

Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the ‘LC-Signature’ header (value ‘sha256=’). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic.

string? WebhookUrl

URL to receive webhook POST notifications

ReturnsExpand Collapse

class SplitCreateResponse:

A split job.

required string ID

Unique identifier for the split job.

required IReadOnlyList<SplitCategory> Categories

Categories used for splitting.

required string Name

Name of the category.

maxLength200

minLength1

string? Description

Optional description of what content belongs in this category.

maxLength2000

minLength1

required DocumentInputType DocumentInputType

Whether the input was a file or parse job

One of the following:

"file_id"FileID

"parse_job_id"ParseJobID

"url"Url

required string FileInput

File ID or parse job ID

required string ProjectID

Project this job belongs to.

required string Status

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

required string UserID

User who created this job.

string? ConfigurationID

Split configuration ID used for this job.

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

string? ErrorMessage

Error message if the job failed.

SplitResultResponse? Result

Result of a completed split job.

required IReadOnlyList<SplitSegmentResponse> Segments

List of document segments.

required string Category

Category name this split belongs to.

required string ConfidenceCategory

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

required IReadOnlyList<Long> Pages

1-indexed page numbers in this split.

SplittingStrategy SplittingStrategy

Strategy used for splitting.

AllowUncategorized AllowUncategorized

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"Forbid

"include"Include

"omit"Omit

string? CustomInstructions

Free-form guidance for where segment boundaries are placed.

maxLength5000

Long MinPagesPerSplit

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

minimum1

string? TransactionID

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

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Create Split Job

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

SplitCreateParams parameters = new()
{
    FileInput = "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
};

var split = await client.Split.Create(parameters);

Console.WriteLine(split);

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}