## List Split Jobs

`client.split.list(SplitListParamsquery?, RequestOptionsoptions?): PaginatedCursor<SplitListResponse>`

**get** `/api/v1/split/jobs`

List document split jobs.

### Parameters

- `query: SplitListParams`

  - `created_at_on_or_after?: string | null`

    Include items created at or after this timestamp (inclusive)

  - `created_at_on_or_before?: string | null`

    Include items created at or before this timestamp (inclusive)

  - `job_ids?: Array<string> | null`

    Filter by specific job IDs

  - `organization_id?: string | null`

  - `page_size?: number | null`

  - `page_token?: string | null`

  - `project_id?: string | null`

  - `status?: "cancelled" | "completed" | "failed" | 2 more | null`

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

    - `"cancelled"`

    - `"completed"`

    - `"failed"`

    - `"pending"`

    - `"processing"`

### Returns

- `SplitListResponse`

  A split job.

  - `id: string`

    Unique identifier for the split job.

  - `categories: Array<SplitCategory>`

    Categories used for splitting.

    - `name: string`

      Name of the category.

    - `description?: string | null`

      Optional description of what content belongs in this category.

  - `document_input_type: "file_id" | "parse_job_id" | "url"`

    Whether the input was a file or parse job

    - `"file_id"`

    - `"parse_job_id"`

    - `"url"`

  - `file_input: string`

    File ID or parse job ID

  - `project_id: string`

    Project this job belongs to.

  - `status: string`

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

  - `user_id: string`

    User who created this job.

  - `configuration_id?: string | null`

    Split configuration ID used for this job.

  - `created_at?: string | null`

    Creation datetime

  - `error_message?: string | null`

    Error message if the job failed.

  - `parse_config_id?: string | null`

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

  - `parse_tier?: string | null`

    Parse tier requested for this job, if any.

  - `result?: SplitResultResponse | null`

    Result of a completed split job.

    - `segments: Array<SplitSegmentResponse>`

      List of document segments.

      - `category: string`

        Category name this split belongs to.

      - `confidence_category: string`

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

      - `pages: Array<number>`

        Page numbers in this segment, as numbered by the input document.

  - `splitting_strategy?: SplittingStrategy`

    Strategy used for splitting.

    - `allow_uncategorized?: "forbid" | "include" | "omit"`

      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.

      - `"forbid"`

      - `"include"`

      - `"omit"`

    - `custom_instructions?: string | null`

      Free-form guidance for where segment boundaries are placed.

    - `min_pages_per_split?: number`

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

  - `target_pages?: string | null`

    Page selection requested for this job, if any.

  - `transaction_id?: string | null`

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

  - `updated_at?: string | null`

    Update datetime

### Example

```typescript
import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const splitListResponse of client.split.list()) {
  console.log(splitListResponse.id);
}
```

#### Response

```json
{
  "items": [
    {
      "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",
      "parse_config_id": "parse_config_id",
      "parse_tier": "parse_tier",
      "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
      },
      "target_pages": "target_pages",
      "transaction_id": "transaction_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
```