API Reference

Split

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Split Job

SplitCancelResponse Split.Cancel(SplitCancelParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/split/jobs/{split_job_id}/cancel

Cancel a running split job.

Requests cancellation; the job transitions to CANCELLED asynchronously once processing stops. Returns the job, which may still be in its current non-terminal state. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.

ParametersExpand Collapse

SplitCancelParams parameters

required string splitJobID

string? organizationID

string? projectID

ReturnsExpand Collapse

class SplitCancelResponse:

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

Cancel Split Job

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

SplitCancelParams parameters = new() { SplitJobID = "split_job_id" };

var response = await client.Split.Cancel(parameters);

Console.WriteLine(response);

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