Skip to content

Manged errors

In case of manged errors, the API resources return the HTTP 200 OK status and a JSON response with this format:

{
    "success": false
    "errors": [
        {
            "code": error code,
            "message": error message
        }
    ],
}

The Boolean property success indicates that processing was not successful while the error object contains the error details.

An example of this is submitting an analysis or classification resource a JSON object without the text property:

{
    "errors": [
        {
            "code": "PREPARE_DOCUMENT_FAILED",
            "message": "missing layout key in json"
        }
    ],
    "success": false
}