API Reference

Split

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Split Job

client.Split.Get(ctx, splitJobID, query) (*SplitGetResponse, error)

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

Get a document split job.

ParametersExpand Collapse

splitJobID string

query SplitGetParams

OrganizationID param.Field[string]Optional

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type SplitGetResponse struct{…}

A split job.

ID string

Unique identifier for the split job.

Categories []SplitCategory

Categories used for splitting.

Name string

Name of the category.

maxLength200

minLength1

Description stringOptional

Optional description of what content belongs in this category.

maxLength2000

minLength1

DocumentInputType SplitGetResponseDocumentInputType

Whether the input was a file or parse job

One of the following:

const SplitGetResponseDocumentInputTypeFileID SplitGetResponseDocumentInputType = "file_id"

const SplitGetResponseDocumentInputTypeParseJobID SplitGetResponseDocumentInputType = "parse_job_id"

const SplitGetResponseDocumentInputTypeURL SplitGetResponseDocumentInputType = "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 stringOptional

Split configuration ID used for this job.

CreatedAt TimeOptional

Creation datetime

formatdate-time

ErrorMessage stringOptional

Error message if the job failed.

Result SplitResultResponseOptional

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 SplitGetResponseSplittingStrategyOptional

Strategy used for splitting.

AllowUncategorized stringOptional

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.

One of the following:

const SplitGetResponseSplittingStrategyAllowUncategorizedForbid SplitGetResponseSplittingStrategyAllowUncategorized = "forbid"

const SplitGetResponseSplittingStrategyAllowUncategorizedInclude SplitGetResponseSplittingStrategyAllowUncategorized = "include"

const SplitGetResponseSplittingStrategyAllowUncategorizedOmit SplitGetResponseSplittingStrategyAllowUncategorized = "omit"

CustomInstructions stringOptional

Free-form guidance for where segment boundaries are placed.

maxLength5000

MinPagesPerSplit int64Optional

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

minimum1

TransactionID stringOptional

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

UpdatedAt TimeOptional

Update datetime

formatdate-time

Get Split Job

Go

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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"),
  )
  split, err := client.Split.Get(
    context.TODO(),
    "split_job_id",
    llamacloud.SplitGetParams{

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

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}