SDK Integration

Integrate a Crop model using the Mindee SDKs.

Use the SDKs to send files to a Crop model and process crop 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:

• Crop Quick Start ⇒ install a client library, send a file, and get your first result.

• Crop Result ⇒ access detected items, object types, and optional chained extraction results.

• Crop Model Overview ⇒ understand how Crop models detect documents or objects on a page.

Typical SDK workflow

1

Create Your Model

Create your Crop 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 Crop model's ID and send a file or URL for processing.

Start with polling unless you already use webhooks.

4

Process the crop results

Read the list of detected items from the response.

Use each item's object type, page, and polygon in your workflow.

Before you start

Have these ready:

• your API key

• your Crop Model's unique ID

• a sample file for testing

• a language choice for the SDK

What is specific to Crop models

Crop responses contain a list of detected items found in the source file.

Each item includes an object type and a location.

The location contains a 0-based page index and polygon coordinates.

Object types are returned exactly as configured on the platform.

If extraction chaining is enabled, each crop item 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