Endpoints

Mindee's REST API endpoints are specific point of entries used to make requests.

• Synchronous Prediction: this endpoint is one of the two ways to extract information from your document in real-time. Via HTTPS, you send your document including in the body a binary file, a base64 encoded string, or an URL. You receive the prediction in the response body as a JSON.
• Asynchronous Prediction: this endpoint is one of the two ways to extract information from your batch of documents. Via HTTPS, you send your document including in the body a binary file, a base64 encoded string, or a URL. You receive the prediction on your webhook as a JSON.
• Feedback: this endpoint can be activated on demand. It allows users to send back corrected predictions to Mindee.

Base URL

Mindee provides off-the-shelf and custom APIs. To make a prediction, we use the REST interface where you can make requests over HTTPS protocol. Each URL starts with the same base URL: https://api.mindee.net/v1.

Authentication

Each request made to the Mindee REST API must be authenticated with an API key generated on the Mindee platform. See Authenticate your API calls to understand how Mindee's document parsing API authentication works.

JSON Response

When calling any Mindee's REST API endpoint, you will get a standardized JSON object as a response. This JSON object always has an api_request key that contains global information on the request you just made.

{
  "api_request": 
  {
    "error": {}, 
    "resources": ["document"], 
    "status": "success", 
    "status_code": 201, 
    "url": "https://api.mindee.net/v1/products/<account_name>/<api_name>/<api_version>/predict"
  }, 
  "document": {...}
}

Questions?
  Join our Slack