Split

Create Split Job

Changed on

Create a split job.

Document input

Set file_input to a file ID or a completed parse job ID (pjb-...). Supplying a parse job reuses its output instead of reading the document again.

Page selection

configuration.target_pages selects which pages of a supplied parse job to split (1-based; 1-50, 1,3,5-7). Pages are read in ascending document order, and each segment's pages are the parse job's own page numbers, so segments map straight back to the original document. Requires a parse job as file_input; passing it with a file ID returns 400.

Parse settings

configuration.parse_tier and configuration.parse_config_id control how the document is read before splitting; both are ignored when a parse job is supplied. A parse configuration restricted to a page subset (target_pages or max_pages) is rejected, since split results always number pages relative to the full document.

The job runs asynchronously. Poll GET /split/jobs/{split_job_id} or register a webhook to monitor completion.

post/api/v1/split/jobs

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/split/jobs
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

transaction_idstring nullable

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

webhook_configuration_idsstring[] nullable

IDs of saved webhook configurations to notify for this job.

configuration_idstring nullable

Saved configuration ID

file_inputstring required

File ID or parse job ID

Example request

{
  "transaction_id": "tx-unique-idempotency-key",
  "webhook_configuration_ids": [
    "whc-...",
    "whc-..."
  ],
  "webhook_configurations": [
    {
      "webhook_url": "https://example.com/webhooks/llamacloud",
      "webhook_headers": {
        "Authorization": "Bearer sk-..."
      },
      "webhook_signing_secret": "whsec_...",
      "webhook_events": [
        "parse.success",
        "parse.error"
      ],
      "webhook_output_format": "json"
    }
  ],
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "configuration": {
    "splitting_strategy": {
      "custom_instructions": "Start a new segment at every signature page."
    },
    "version": "latest",
    "parse_tier": "fast",
    "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
    "target_pages": "1,3,5-7"
  },
  "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

Response

Successful Response

idstring required

Unique identifier for the split job.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

transaction_idstring nullable

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

file_inputstring required

File ID or parse job ID

project_idstring required

Project this job belongs to.

user_idstring required

User who created this job.

configuration_idstring nullable

Split configuration ID used for this job.

document_input_type'url' | 'file_id' | 'parse_job_id' required

Whether the input was a file or parse job

parse_tierstring nullable

Parse tier requested for this job, if any.

parse_config_idstring nullable

Saved parse configuration ID requested for this job, if any.

target_pagesstring nullable

Page selection requested for this job, if any.

versionstring required

Split version used for this job.

statusstring required

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

error_messagestring nullable

Error message if the job failed.

Example response

{
  "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "splitting_strategy": {
    "custom_instructions": "Start a new segment at every signature page."
  },
  "version": "1.1.0"
}

Changes