---
title: "Preview a splitter without writing document segments"
method: POST
path: "/splitters/{id}/test"
tags: ["Splitters"]
---

# Preview a splitter without writing document segments

`POST /splitters/{id}/test`

## Request

- Base URL: `https://api.pdfparse.net/v1`
- URL: `https://api.pdfparse.net/v1/splitters/{id}/test`
- Auth: HTTP bearer

Compile the draft or a published version against a document page count and report segments, gaps, overlaps, review state, and downstream page fan-out.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string: Scopes replay protection to the authenticated project, method, and route for 24 hours.

## Request body

- object
  - `page_count` integer, required
  - `version` integer

## Response `200`

Success

- object
  - `splitter_id` string, required
  - `version` integer, nullable, required
  - `draft_revision` integer, nullable, required
  - `page_count` integer, required
  - `segments` object[], required
    - `segment_key` string, required
    - `section_key` string, required
    - `section_name` string, required
    - `destination_table_id` string, required
    - `page_spans` object[], required
      - `start_page` integer, required
      - `end_page` integer, required
    - `page_count` integer, required
    - `ordinal` integer, required
    - `review_required` boolean, required
  - `unassigned_page_spans` object[], required
    - `start_page` integer, required
    - `end_page` integer, required
  - `overlaps` object[], required
    - `page` integer, required
    - `section_keys` string[], required
  - `review_required` boolean, required
  - `unique_assigned_page_count` integer, required
  - `downstream_page_count` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Workflow error

---

[API](https://skmtc.dev/pdfparse/apis/pdfparse-api.md) · [All operations](https://skmtc.dev/pdfparse/apis/pdfparse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pdfparse/apis/pdfparse-api/revisions/fb9f7c930c6d?raw)