Quickstart

Sign Up!

You'll need an account ;-)

You can connect using your Google or Github account, or create an account using good old-fashioned email and password.

Create a Model

The quickest way is to use a predefined model by selecting one from the catalog.

If there are no pre-built models that suit your needs, you can:

• Modify a model from the catalog

• Create your own model from scratch

Test the Model

Be sure to make at least one test on a document, using the Live Test feature.

If it doesn't work as expected, you can modify the Data Schema, as explained in Modifying Your Data Schema.

Create an API Key

On the left-hand menu of the Mindee Platform, click API Keys and create a new key.

Send a File or URL

You can easily send a file or an URL using one of our officially-supported Client Libraries / SDKs.

For a quick introduction and ready to use code samples, check out the Quick Start section.

Otherwise, you can use the built-in client in our API Reference.

Process the Result

You'll need some way of importing the JSON structure and manipulating it.

For quick testing, we recommend to Process the Response using our client libraries.