Split

Get Split Job

Changed on

Get a document split job.

get/api/v1/split/jobs/{split_job_id}

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/{split_job_id}
  • Auth: HTTP bearer

Path parameters

split_job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

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