General description of how to integrate the Mindee API.
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.
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.
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.
For a quick introduction and copy-paste ready code, look in the Quick Start section.
You can ask for specific code samples from the documentation AI.
Use the "Ask" button at the top of any page, or click below:
Supported languages/frameworks: Python, Node.js (JS/TS), PHP, Ruby, Java, .NET (C#).
If you're integrating using a no-code or low-code platform, take a look at the No-Code Integrations section.
If none of the above options fit your requirements, take a look at the Manual Integration section.
We do not recommend manually integrating, and cannot provide full support in this case.
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.
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 for testing and small volumes.
Webhook Results sends directly to your server, and is more suited for heavy production use.
Last updated
Was this helpful?
Was this helpful?