Errors
This section describes the possible errors and response codes returned by the API.
Response Error Codes
The FreeConvert API returns the following standard HTTP status codes when an error is encountered:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request parameter is invalid. |
| 401 | Unauthorized -- Your API key is invalid. |
| 402 | Payment Required -- Your subscription has expired or exceeded its limit. |
| 403 | Forbidden -- Your access is denied. |
| 404 | Not Found -- The specified content could not be found. |
| 405 | Method Not Allowed -- You tried to access with an invalid method. |
| 406 | Not Acceptable -- You used a format that is not JSON. |
| 429 | Too Many Requests -- You are sending too many requests. |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
Rate Limits
The FreeConvert API is rate limited. If your API requests are rate limited, you will receive a 429 HTTP response code.
Task/Job Error Info
If a Job or Task has a status of failed, additional error information is provided in the errorCode and msg (optional) attributes of the Job's or Task's result object.
// errorCode indicated on Task or Job object
{
....
result: {
errorCode: 'specific error code',
msg: 'additional message about the error'
}
...
}
Possible error codes of Task
| errorCode | Meaning |
|---|---|
| upload_timeout | File upload timeout exceeded. |
| engine_timeout | Conversion timeout exceeded due to our internal server issue. |
| out_of_conversion_minutes | Available conversion minutes are finished for this user. |
| out_of_conversion_minutes_per_task | Available conversion minutes are finished for this task. |
| user_deleted_task | Task failed due to the deletion operation of the user. |
| insufficient_permission | Task failed due to insufficient permission. |
| invalid_credentials | Task failed due to invalid credentials. |
| processing_failed | Task failed due to internal process failure. |
A job will fail if any of its tasks have failed, been canceled, or been deleted.
Possible error codes of Job
| errorCode | Meaning |
|---|---|
| task_failed | Job failed due to the failure of one of its tasks. |
| task_deleted | Job failed due to the deletion of one of its tasks. |
| task_canceled | Job failed due to the cancellation of one of its tasks. |