Overview
Errors
VoiStrix uses conventional HTTP status codes to indicate the success or failure of an API
request. Codes in the range of 2xx indicate a successful request and will often return a response
body. Codes in the range of 4xx indicate errors that failed the given request. An error message is
provided to help indicate what the issue is and in many cases can be handled programmatically to
take proper action. Codes in the 5xx range indicate an error with the VoiStrix service
and are considered rare.
In some circumstances, additional information is provided in the extra field of the response body
when an error occurs.
Below you will find the error status codes that the VoiStrix service can return.
400 - Invalid request. Check the request parameters and try again.
401 - Authentication required. Please provide valid credentials.
403 - Access denied. You do not have permission to perform this action.
404 - Resource not found. The requested endpoint or resource does not exist.
405 - HTTP method not allowed. Verify that the request method is correct for this resource.
408 - The server timed out waiting for the request. Try again later.
409 - Request conflict detected, possibly due to a duplicate resource.
429 - Rate limit exceeded. Please slow down and try again later.
500 - An unexpected error occurred on the server. Please try again later.
502 - Received an invalid response from the upstream server.
503 - Service is temporarily unavailable. Please try again later.Error Response - [Map]
An object to describe the error that occurred.
Attributes
- errorCode - REQUIRED[Integer]
A custom error code to uniquely identify the problem.
- extra - OPTIONAL[Map]
Contains any additional information about the error.
- message - REQUIRED[String]
A message identifying what went wrong.
{
"errorCode": 0,
"extra": {},
"message": "string"
}