| description | General description of how to integrate the Mindee API. |
|---|---|
| icon | print-magnifying-glass |
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.md section for more details. This can be any model type (extraction or utility model), all models are integrated in a very similar way.
We recommend using the live-test.md feature before attempting to integrate the API.
You'll also need at least one API key, see the api-keys.md section for more info.
We highly recommend using one of our client-libraries-sdk.
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.md section.
{% hint style="success" %}
You can ask for specific code samples from the documentation AI.
Use the "Ask" button at the top of any page, or click below:
Ask "Write a code sample for my extraction model, ask for my model ID and language first" {% endhint %}
Supported languages/frameworks: Python, Node.js (JS/TS), PHP, Ruby, Java, .NET (C#).
We provide full support for Client Libraries regardless of your plan. You can report any issues on our bug tracker or directly on GitHub.
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 api-reference section.
{% hint style="warning" %} We do not recommend manually integrating, and cannot guarantee full support.
Pro plans and above benefit from extended integration support. {% endhint %}
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.md uses a GET route, and is better suited for testing and small volumes.
webhooks.md sends directly to your server, and is more suited for heavy production use.