Create a logical splitter draft for mixed documents

Bind to one project inbox, or use a null sourceInboxId for project uploads. Publishing activates routing through project classification rules.

Authorization

BearerAuth

AuthorizationBearer <token>

Project-scoped user API key

In: header

Header Parameters

Idempotency-Key?string

Scopes replay protection to the authenticated project, method, and route for 24 hours.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

description?|

Lengthlength <= 500

config*

Response Body

`application/json`

Request Examples

bash

curl -X POST "https://api.pdfparse.net/splitters/logical" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "config": {
      "mode": "logical",
      "sourceInboxId": "string",
      "instructions": "stringstri",
      "sectionTypes": [
        {
          "key": "string",
          "name": "string"
        }
      ],
      "routingMode": "project_rules",
      "reviewUncertainBoundaries": true,
      "reviewUncertainDestinations": true
    }
  }'

Response Samples

application/json

{
  "id": "string",
  "name": "string",
  "description": "string",
  "mode": "page_range",
  "status": "draft",
  "draft_revision": 0,
  "latest_version": 0,
  "config": {
    "mode": "page_range",
    "overlap_policy": "exclusive",
    "unassigned_policy": "review",
    "fallback_section_key": "string",
    "max_segments": 50,
    "sections": [
      {
        "section_key": "string",
        "name": "string",
        "description": "string",
        "destination_table_id": "string",
        "page_spans": [
          {
            "start_page": 1,
            "end_page": 1
          }
        ]
      }
    ]
  },
  "created_at": "string",
  "updated_at": "string"
}

Authorization

Header Parameters

Request Body

Response Body

201application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`