> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unsiloed.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Response Format

> Response shape from the /splitter endpoint, with a field-by-field reference.

A completed splitting job returns one entry per split file in `result.files`, each with a download URL and a confidence score for the classification. The example below is a real response from splitting a bundle of pages from a mutual fund annual report that contained a fund performance summary, a schedule of investments, and a financial statement.

```json theme={null}
{
  "job_id": "c68959b4-87cc-4cd5-984e-47f14dfad6cb",
  "status": "completed",
  "progress": "Starting document splitting...",
  "error": null,
  "file_url": "https://example-bucket.s3.amazonaws.com/user_uploads/...?AWSAccessKeyId=...&Signature=...&Expires=...",
  "file_name": "calamos-fund-report-bundle.pdf",
  "parameters": {
    "classes": ["Fund Performance", "Schedule of Investments", "Financial Statements"],
    "page_count": 3,
    "enable_reordering": false,
    "category_descriptions": {
      "Fund Performance": "Fund performance summary with growth chart and average annual total return table",
      "Schedule of Investments": "Itemized list of portfolio holdings with values",
      "Financial Statements": "Statements of assets and liabilities, operations, and changes in net assets"
    }
  },
  "result": {
    "success": true,
    "message": "Successfully split PDF into 3 files",
    "files": [
      {
        "name": "Fund Performance.pdf",
        "path": "Fund Performance.pdf",
        "type": "file",
        "fileId": "cbe0c91c-8577-4bfb-a43a-b40f3932592c",
        "full_path": "https://example-bucket.s3.amazonaws.com/files/...?AWSAccessKeyId=...&Signature=...&Expires=...",
        "confidence_score": 0.9999979255377075
      },
      {
        "name": "Schedule of Investments.pdf",
        "path": "Schedule of Investments.pdf",
        "type": "file",
        "fileId": "dc0955b6-3bd7-4373-b356-cce3c8cf31f0",
        "full_path": "https://example-bucket.s3.amazonaws.com/files/...?AWSAccessKeyId=...&Signature=...&Expires=...",
        "confidence_score": 0.9999979255377075
      },
      {
        "name": "Financial Statements.pdf",
        "path": "Financial Statements.pdf",
        "type": "file",
        "fileId": "e41bccff-6200-484d-9e1e-92cdd02b48bc",
        "full_path": "https://example-bucket.s3.amazonaws.com/files/...?AWSAccessKeyId=...&Signature=...&Expires=...",
        "confidence_score": 0.9999979255377075
      }
    ]
  }
}
```

## Top-Level Fields

* **`job_id`:** unique identifier for the split job
* **`status`:** job state. `queued` while the job waits to be picked up, `processing` while it runs, then `completed` or `failed`.
* **`progress`:** human-readable progress message
* **`error`:** error message if the job failed, otherwise `null`
* **`file_url`:** presigned download URL for the original uploaded file. Expires roughly an hour after the response is generated. Re-issue `GET /splitter/{job_id}` to get a fresh URL.
* **`file_name`:** name of the original file
* **`parameters`:** echo of the parameters used for this job (described below)
* **`result`:** the split files (described below)

## Parameters Object

The `parameters` block echoes the inputs used for the split, including defaults applied by the API.

* **`classes`:** the category names you submitted
* **`page_count`:** number of pages in the uploaded document
* **`enable_reordering`:** whether the splitter reordered pages within each category after classification. Only applied to categories with more than one matched page. Defaults to `false`.
* **`category_descriptions`:** the descriptions you submitted for each category

## Result Object

* **`success`:** whether the split operation succeeded
* **`message`:** human-readable success or failure message
* **`files`:** array of generated split files, one per matched category. Pages sharing a category are grouped into a single file, so a bundle with several schedule-of-investments pages yields one Schedule of Investments.pdf containing all of them.

## File Object

Each entry in `result.files` represents one split document.

* **`name`:** name of the split file, derived from the matched category
* **`path`:** relative path to the file
* **`type`:** file type, always `"file"`
* **`fileId`:** unique identifier for the file
* **`full_path`:** presigned download URL for the split file. Expires roughly an hour after the response is generated, so download or copy the file straight away rather than storing the URL. To get a fresh URL, re-issue `GET /splitter/{job_id}`.
* **`confidence_score`:** classification confidence for this file (0–1), averaged across all pages assigned to the category

For the full request and response specification, see the [Split API reference](/docs/api-reference/splitting/split-document).
