SDK Integration

Integrate a Split model using the Mindee SDKs.

Use the SDKs to send multi-page files to a Split model and process split results.

This section helps you choose the right starting point and move through the full integration flow.

Choose your path

Start with the page that matches your next step:

• Split Quick Start ⇒ install a client library, send a file, and get your first result.
• Split Result ⇒ access split ranges, document types, and optional chained extraction results.
• Split Model Overview ⇒ understand how Split models group pages into logical documents.

Typical SDK workflow

1

Create Your Model

Create your Split Model on the Mindee platform.

Upload some samples to the Live Test to validate the model.

2

Install and authenticate

Install the client library for your language.

Prepare your API key and initialize the client.

3

Send a file

Set the Split model's ID and send a file or URL for processing.

Start with polling unless you already use webhooks.

4

Process the split results

Read the list of detected documents from the response.

Use each split's document type and page range in your workflow.

Before you start

Have these ready:

• your API key
• your Split Model's unique ID
• a multi-page sample file for testing
• a language choice for the SDK

What is specific to Split models

Split responses contain a list of logical documents found in the source file.

Each split includes a document type and a 0-based page range.

Document types are returned exactly as configured on the platform.

If extraction chaining is enabled, each split can also include an extraction response.

Shared SDK building blocks

Integration builds on the same client library concepts used across all model types.

• Client Libraries / SDKs
• Client Configuration
• Send a File or URL
• Response Processing
• Webhook Results
• Error Handling