Platform tour

This section provides an insight into the basics of Mindee UI. It describes all the features and its function.


Mindee API Store on the left and Your APIs on the rightMindee API Store on the left and Your APIs on the right

When you create an account at Mindee, you'll land on the APIs Hub. There are two sections on this page: The Off-the-shelf APIs in the APIs store and Your APIs which are off-the-shelf APIs currently in use and custom generated APIs.

To use an API, click on the corresponding API card you want from the API store. If you can't find what you're looking for in the off-the-shelf API Store, you can build it yourself by clicking on the Create a new API button. Follow this tutorial to guide you through the process of creating your own API.

API Filtering by Location

API filtering by location showing the different countryAPI filtering by location showing the different country

You can filter your off-the-shelf APIs in the APIs store by location; this makes it easier to find the APIs you wish to use. However, regardless of your location, you will be able have access to all available off-the-shelf APIs.

Some of the APIs listed are relevant only to a certain location; for example, the French ID card API won't be that relevant to someone in the United States unless there is a specific need for it.

Here are the region specific off-the-shelf APIs currently available:




These are not documented yet (working on it), but if you use any other off-the-shelf API, you should be able to use them without any issues. If you need any help, feel free to ask on our Slack community

  • Carte Nationale d'Identité.
  • Carte Vitale.

Note: You can use all these available off-the-shelf API no matter your location.

API - Dashboard

Mindee API dashboard with the different sectionMindee API dashboard with the different section

From the dashboard, you can monitor and manage your usage and your plan. The dashboard has two main sections:

  • API usage section
  • API metrics section

API Usage

Dashboard API usageDashboard API usage

You can view your current monthly plan and usage under the API usage. The default subscription is a free plan that renews automatically each month. To customize your subscription, click on the Go unlimited button. If your plan is active, it will be automatically renewed each month.

API Metrics

Dashboard API metricsDashboard API metrics

In the API Metrics section you can view your:

  • Traffic: Number of inputs processed (images and pdf pages).
  • Errors: Number of HTTP errors.
  • Latency: Average server-side computation time in milliseconds.

API - Documentation

Mindee APIs documentation with the different sectionMindee APIs documentation with the different section

Whether it's an off-the-shelf API from the API Store or a custom-built API, you can access the specific documentation to help you test and integrate easily. The documentation has different sections which are:

  • API Reference
  • Response scheme
  • Limitations
  • Open API

API Reference

API reference section with its sub-sectionAPI reference section with its sub-section

From the API reference section you can view:

  • HTTP Request: This contains all the main information you need to make a request to your API, such as base URL, Content-type, Authentication headers, and form data.
  • Sample code: This contains ready to use sample codes in different languages which you can copy and paste in your environment.

Response scheme

Response scheme section with its sub-sectionResponse scheme section with its sub-section

From the Response scheme section you can view:

  • Response structure: This contains a full JSON response example along with a few details about how to access your document level predictions.
  • Extracted fields: This provides details about every field extracted by the API within a document.


Limitations section with its sub-sectionLimitations section with its sub-section

From the limitations section you can view:

  • Supported documents: This contains details on the type of documents you can send to the API for parsing.
  • Rate limits: This provides information on the rate limits of each API depending on your plan.

Open API

Open API swagger-like interface sectionOpen API swagger-like interface section

The OpenAPI section is a swagger-like user interface that allows you to navigate through your API technical information. You can also download the OpenAPI definition of your API.

API - API Keys

Mindee API KeysMindee API Keys

With the API keys section, you can create numerous API keys according to your needs, retrieve, and delete your API keys. Follow these steps listed here to create an API key.

To delete an API key:

  1. Click on the trash icon located on the left.
    API key with trash icon on the leftAPI key with trash icon on the left
  2. A dialog box will pop out, type the name of your API key and click on the Delete API button.

Mindee Delete API KeysMindee Delete API Keys

Note: It is important to note that if you delete your API keys, it cannot be revoked.

API - Live interface

Mindee API live interface sectionMindee API live interface section

This is your home for no code testing. In our graphical user interface, you can drag and drop your documents to see the API in action. You can also see all of the extracted information, as well as the raw API JSON response in one location. For custom-built APIs, a trained model is required before the live interface can be used.

API - Models

Mindee API Models sectionMindee API Models section

This section is only available for custom APIs built using the API Builder. You can monitor the status of your training in real time, informing you when it is in progress, deployed, or canceled.

API - Training

Mindee API Training sectionMindee API Training section

This section is only available for custom APIs built using the API Builder. In this section, you can train your custom-built API by annotating data. The left part of the Training interface is the viewer. You can drag and drop single documents or archives you want to annotate. The right part of the screen is your data model. Each field you've set up in your data model appears here.

API - Settings

Mindee API settings sectionMindee API settings section

This section is only available for custom APIs built using the API Builder. In this section, you can modify the metadata about your API. In the Actions section, you can also:

  • Download your training data: An email with your training data (raw files and annotations) will be sent to you and your account admins.
  • Download your data model config: It's the json formatted data model of your API. Downloading this configuration file will help you duplicate your API if you want to create a similar one.
  • Delete your API: You can delete your API, along with all its training data. This action is permanent and cannot be undone.


Slack Logo IconSlack Logo Icon  Join our Slack

Did this page help you?