Error Management

Mindee REST API Status and Error Codes

To indicate successful execution or when error occur, we utilize standard HTTP codes. In the case of errors, the response will contain extra information about the error with an error code.

JSON Response

Mindee REST APIs return either 200 (OK) or 201 (Created) when an API request successfully runs to completion. Status codes in the 400-500 range indicate failures.

Successful Execution

Those operations that complete successfully will return 2xx status codes in addition to the API response status information in the response body.

{
  "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": {...}
}

The table below shows the typical response codes supported by Mindee API.

Error Handling

If an error occurs when calling Mindee's REST API because of an issue with the client's input (such as incorrect data), the standard error code 4xx is used. If an operation fails because of an issue with the Mindee server, a 5xx error code will be returned.

In the JSON format you will find a code in the error response key that gives a description of the error that occurred.

{
  "api_request": {
    "status": "failure",
    "status_code": 401,
    "resources": [],
    "url": "https://api.mindee.net/v1/products/mindee/expense_receipts/v3/predict",
    "error": {
      "details": "No token provided",
      "message": "Authorization required",
      "code": "Unauthorized",
     },
   }
}

Errors happening can be split in two main parts:

4xx Errors - Client Errors

5xx Errors - Server Errors

 

Questions?
  Join our Slack