## List Split Jobs

`client.Split.List(ctx, query) (*PaginatedCursor[SplitListResponse], error)`

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

List document split jobs.

### Parameters

- `query SplitListParams`

  - `CreatedAtOnOrAfter param.Field[Time]`

    Include items created at or after this timestamp (inclusive)

  - `CreatedAtOnOrBefore param.Field[Time]`

    Include items created at or before this timestamp (inclusive)

  - `JobIDs param.Field[[]string]`

    Filter by specific job IDs

  - `OrganizationID param.Field[string]`

  - `PageSize param.Field[int64]`

  - `PageToken param.Field[string]`

  - `ProjectID param.Field[string]`

  - `Status param.Field[SplitListParamsStatus]`

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

    - `const SplitListParamsStatusCancelled SplitListParamsStatus = "cancelled"`

    - `const SplitListParamsStatusCompleted SplitListParamsStatus = "completed"`

    - `const SplitListParamsStatusFailed SplitListParamsStatus = "failed"`

    - `const SplitListParamsStatusPending SplitListParamsStatus = "pending"`

    - `const SplitListParamsStatusProcessing SplitListParamsStatus = "processing"`

### Returns

- `type SplitListResponse struct{…}`

  A split job.

  - `ID string`

    Unique identifier for the split job.

  - `Categories []SplitCategory`

    Categories used for splitting.

    - `Name string`

      Name of the category.

    - `Description string`

      Optional description of what content belongs in this category.

  - `DocumentInputType SplitListResponseDocumentInputType`

    Whether the input was a file or parse job

    - `const SplitListResponseDocumentInputTypeFileID SplitListResponseDocumentInputType = "file_id"`

    - `const SplitListResponseDocumentInputTypeParseJobID SplitListResponseDocumentInputType = "parse_job_id"`

    - `const SplitListResponseDocumentInputTypeURL SplitListResponseDocumentInputType = "url"`

  - `FileInput string`

    File ID or parse job ID

  - `ProjectID string`

    Project this job belongs to.

  - `Status string`

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

  - `UserID string`

    User who created this job.

  - `ConfigurationID string`

    Split configuration ID used for this job.

  - `CreatedAt Time`

    Creation datetime

  - `ErrorMessage string`

    Error message if the job failed.

  - `Result SplitResultResponse`

    Result of a completed split job.

    - `Segments []SplitSegmentResponse`

      List of document segments.

      - `Category string`

        Category name this split belongs to.

      - `ConfidenceCategory string`

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

      - `Pages []int64`

        1-indexed page numbers in this split.

  - `SplittingStrategy SplitListResponseSplittingStrategy`

    Strategy used for splitting.

    - `AllowUncategorized string`

      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.

      - `const SplitListResponseSplittingStrategyAllowUncategorizedForbid SplitListResponseSplittingStrategyAllowUncategorized = "forbid"`

      - `const SplitListResponseSplittingStrategyAllowUncategorizedInclude SplitListResponseSplittingStrategyAllowUncategorized = "include"`

      - `const SplitListResponseSplittingStrategyAllowUncategorizedOmit SplitListResponseSplittingStrategyAllowUncategorized = "omit"`

    - `CustomInstructions string`

      Free-form guidance for where segment boundaries are placed.

    - `MinPagesPerSplit int64`

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

  - `TransactionID string`

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

  - `UpdatedAt Time`

    Update datetime

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Split.List(context.TODO(), llamacloud.SplitListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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",
      "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"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
```