Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unsiloed.ai/llms.txt

Use this file to discover all available pages before exploring further.

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 mixed PDF that contained an invoice followed by a restaurant menu. 
{
  "job_id": "210d954a-237a-4387-8f84-3b497f7be387",
  "status": "completed",
  "progress": "Starting document splitting...",
  "error": null,
  "file_url": "https://platform-unsiloed-ai.s3.amazonaws.com/user_uploads/...",
  "file_name": "mixed_documents.pdf",
  "parameters": {
    "classes": ["Invoice", "Menu", "Receipt", "Contract"],
    "page_count": 5,
    "enable_reordering": false,
    "category_descriptions": {
      "Invoice": "Financial invoices with itemized charges",
      "Menu": "Restaurant menus and price lists",
      "Receipt": "Purchase receipts",
      "Contract": "Legal contracts and agreements"
    }
  },
  "result": {
    "success": true,
    "message": "Successfully split PDF into 2 files",
    "files": [
      {
        "name": "Invoice.pdf",
        "path": "Invoice.pdf",
        "type": "file",
        "fileId": "32b8062d-9a02-4568-b96e-7d12bd4849b6",
        "full_path": "https://platform-unsiloed-ai.s3.amazonaws.com/files/...",
        "confidence_score": 0.9999965762531025
      },
      {
        "name": "Menu.pdf",
        "path": "Menu.pdf",
        "type": "file",
        "fileId": "c68057be-4438-4f39-a67c-022039288651",
        "full_path": "https://platform-unsiloed-ai.s3.amazonaws.com/files/...",
        "confidence_score": 0.9999965762531025
      }
    ]
  }
}

​
Top-Level Fields

  • job_id: unique identifier for the split job
  • status: job state (completed, failed, or an in-progress value such as processing)
  • progress: human-readable progress message
  • error: error message if the job failed, otherwise null
  • file_url: signed URL to the original uploaded file
  • 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 before grouping; 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 detected document

​
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: full download URL for the split file
  • confidence_score: confidence score for the classification (0–1)
For the full request and response specification, see the Split API reference.