Integration Overview

General description of how to integrate the Mindee API.

General Description

The Mindee API is RESTful, and returns data in a JSON format.

In this section we'll go over the major steps required for a successful integration, and link to the relevant sections of the documentation.

Before Starting

You'll need at least one model configured, see the Models Overview section for more details.

We recommend using the Live Test feature before attempting to integrate the API.

You'll also need at least one API key, see the API Keys section for more info.

How to Integrate

We highly recommend using one of our Client Libraries / SDKs.

They are the fastest and easiest way to call our APIs, and allow our support teams to better help you.

Client Libraries

For a quick introduction and copy-paste ready code, look in the Quick Start section.

Ask for Code Samples

You can also ask for specific code samples from the documentation AI.

Use the search bar at the top of the page.

No-Code or Low-Code

If you're integrating using a no-code or low-code platform, take a look at the No-Code Integrations section.

Manual Integration

If none of the above options fit your requirements, take a look at the API Reference section.

What to Send

You can send either a local file or an URL, it makes no difference for server-side processing.

However, when using our client libraries, you can Adjust the Source File if you have it locally.

How to Receive Results

Inference operations are always asynchronous, meaning there is a route to POST the file and another mechanism to retrieve the results.

You can decide on using either the polling flow or the webhook flow.

Polling for Results uses a GET route, and is better suited to testing and small volumes.

Webhook Results sends directly to your server, and is more suited to heavy production use.