Error Codes
The Docu-analyzer API uses standard HTTP status codes to indicate problems that occur during request processing.
The response body typically includes a JSON object with specific information about the error.
JSON Example
{
"message": "Document analysis task failed.",
"error": "Internal Server Error",
"statusCode": 500
}Client Errors (4xx)
Errors caused by incorrect client-side requests (e.g., invalid API key, missing file, unsupported format, etc.)
| Status Code | Message | Description |
|---|---|---|
400 Bad Request |
The 'file' field is missing in the request body (form-data). |
Returned when the file field containing file data cannot be found in a multipart/form-data request. |
400 Bad Request |
The format '{format}' you entered is not supported. (Supported formats: xml, md, json) |
Returned when an invalid format is passed in the outputFormats parameter. |
401 Unauthorized |
"API Key authentication failed. Please use a valid API Key for your request." |
Returned when the Authorization header is missing or the Bearer token (API key) is invalid. |
402 Payment Required |
Insufficient credits to perform document analysis. |
Returned when the remaining credits in the account are less than required for document analysis. |
413 Payload Too Large |
The uploaded file exceeds the server limit of 100MB. |
Returned when the size of a single uploaded file exceeds the maximum size (100MB) allowed by the server. |
415 Unsupported Media Type |
Unsupported file format. |
Returned when the format of the uploaded file is not supported by the server. Check Supported Formats. |
Server Errors (5xx)
Cases where the request was valid but processing failed due to unexpected server-side issues.
| Status Code | Message | Description |
|---|---|---|
500 Internal Server Error |
Failed to process the request due to an internal server error. Please try again later. If the problem persists, please contact the administrator. |
Returned when request processing fails due to an unexpected internal server issue. |