Split

List Split Jobs

Changed on

List document split jobs.

get/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

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' nullable

Filter by job status (pending, processing, completed, failed, cancelled)

job_idsstring[] nullable

Filter by specific job IDs

project_idstring uuid nullable
organization_idstring uuid nullable
page_sizeinteger nullable
page_tokenstring nullable
created_at_on_or_afterstring date-time nullable

Include items created at or after this timestamp (inclusive)

created_at_on_or_beforestring date-time nullable

Include items created at or before this timestamp (inclusive)

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "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