# Integration Overview

## 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](/models/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](/models/live-test.md) feature before attempting to integrate the API.

You'll also need at least one API key, see the [Manage API Keys](/integrations/api-keys.md) section for more info.

## How to Integrate

We highly recommend using one of our [Client Libraries / SDKs](/integrations/client-libraries-sdk.md).

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 [Extraction Quick Start](/extraction-models/sdk-integration/quick-start.md) section.

{% hint style="success" %}
**Ask for Code Samples**

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

Use the "Ask" button at the top of any page, or click below:

<button type="button" class="button primary" data-action="ask" data-query="Write a code sample for my extraction model, ask for my model ID and  language first" data-icon="gitbook-assistant">Ask "Write a code sample for my extraction model, ask for my model ID and language first"</button>
{% 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](https://feedback.mindee.com/?b=685c08afd7a1d2e47b124cbb) or directly on [GitHub](https://github.com/orgs/mindee/repositories).

### No-Code or Low-Code

If you're integrating using a no-code or low-code platform, take a look at the [No-Code Integration](/extraction-models/no-code-integration.md) section.

### Manual Integration

If none of the above options fit your requirements, take a look at the [Manual Integration](/integrations/api-reference.md) 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 %}

## 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 [Load and Adjust a File](/integrations/client-libraries-sdk/load-and-adjust-a-file.md#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](/integrations/polling-for-results.md) uses a GET route, and is better suited for testing and small volumes.

[Webhook Results](/integrations/webhooks.md) sends directly to your server, and is more suited for heavy production use.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mindee.com/integrations/api-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.