Get the list of your active contracts
Overview of the error and warning system
When you send a job to the API, a lot of things happen behind the scenes: we get the input files, we validate them, we try to understand which kind of files they are and finally we start the conversion giving back to you the converted file(s).
During this process, something can go wrong either by your side (e.g. a wrong URL for a remote input or a password protected file) or by our side (e.g. we cannot convert yet a particular file format).
If an error condition is detected, the API reports it to you using the errors and warnings arrays inside the JSON responses. This means that for a single job you can receive more than one error or warning.
The errors are conditions that lead to a failed conversion.
The warnings are conditions that lead to a successful conversion but for some reason, it might not be as expected or contain minor issues.
Following is an example of a failed conversion with two input errors inside:
Output Example
"status": {
"code": "failed",
"info": "The file has not been converted due to errors."
},
"errors": [
{
"source": "input",
"id_source": "4ebe940f-7e20-4b5e-9bc1-cdaa5675e3eb",
"code": 401,
"message": "The file could not be downloaded by our servers, because a password has been requested to access the data."
},
{
"source": "input",
"id_source": "ed5c51d7-a2d0-4a93-ac8f-8c58e4af604b",
"code": 404,
"message": "The file could not be downloaded by our servers. Please verify the link you have provided."
}
]
Example of a failed conversion
As you can see, there are always four fields:
- "source": can be either input or conversion
- "id_source": contains the id of the input or the conversion it is referring to. You can find the details about the input or the conversion in the same JSON response
- "code": a unique numerical error code. If you plan on automatically reacting to an error or a warning, you have to check the code, not the message, because this can change at any time, while the code will stay the same
- "message": a human readable explanation of the received error code. Be aware that this message can change at any time in the future, so always use the code
Following is an example of a failed conversion with one conversion error inside:
Output Example
"status": {
"code": "failed",
"info": "The file has not been converted due to errors."
},
"errors": [
{
"source": "conversion",
"id_source": "d9e5b86b-7faa-4048-8cdf-3593b1d3a8bd",
"code": 6005,
"message": "Your file is missing important meta data and we therefore can not convert it."
}
]
List of common errors
Code | Message | Notes |
---|---|---|
2 | The job can not be modified. | Only jobs with status incomplete or ready can be modified. |
5 | Empty or invalid file received. | The remote or locally uploaded file was empty or corrupted. Please try again. |
34 | The total inputs' file size for a conversion has been exceeded and your file discarded. | If you need more power, please upgrade your contract. |
Error related to remote inputs
Errors related to cloud file uploads
Errors related to local file uploads
Errors related to the conversion
Common conversion warnings
Code | Message | Notes | |
---|---|---|---|
20000 | Unfortunately, we detected an issue during conversion. We converted your file as best as possible, but it might be only converted partly. Please check it manually. | Probably something happened during the conversion but we are unable to tell more. Often this results in a usable file nonetheless. | |
20001 | Impossible to write metadata inside the file. | Some of the requested metadata were not written inside the converted file. | |
20002 | Cannot write metadata. | Some of the requested metadata were not written inside the converted file. | |
20003 | Unfortunately, we can not yet convert your file from your source file format to this target file format. | ||
20004 | The rendered output may be incorrect. | ||
20005 | Your file uses an unsupported encryption format. | ||
20006 | The DPI value may be incorrect. | ||
20007 | We could not compress this file any further. | ||
20008 | The version of the converted file has been downgraded. | ||
20009 | It was not possible to preserve transfer functions in PDF 2.0. | ||
20010 | The selected language was not found. Text detection can be incorrect. | ||
20011 | The value for the audio frequency is too low. The conversion used the lowest possible value allowed. You can also try again with a higher value or with a different codec. | ||
20012 | The value for the audio frequency is too high. The conversion used the highest possible value allowed. You can also try again with a smaller value or with a different codec. | ||
20013 | The value for the audio frequency is not allowed. The conversion used the highest possible value allowed. You can also try again with another value or with a different codec. | ||
20014 | The sizes of the reference image and the compared image do not match. The result can be inaccurate. | ||
20015 | The sizes of the reference video and the compared video do not match. The result can be inaccurate. | ||
20016 | The codecs of the input files does not fit the video codec. A different one was chosen. | ||
20017 | The model and the upscale factor chosen failed the conversion. A different combination was automatically chosen. | ||
20018 | The width or height exceed the limit for AI upscaling for your file. The maximum possible size is provided. | ||
20019 | The requested voice is not available for your language. The default gender was used. |