Response & Errors

All responses from the LiveReach AI API will be formatted in the application/json data type, wrapped with a common container JSON object with two keys. The result key will contain meta data about your request and information about the error. The content key will contain the API response.

LiveReach AI uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a forbidden query for your user type, etc.). Codes in the 5xx range indicate an error with LiveReach's servers.

The API may occasionally return information that is not documented in this documentation. Any fields or endpoints that are not explicitly documented are not guaranteed to have any specific behavior or to remain accessible.

HTTP status code summary

Code	Description
200 - OK	Everything worked as expected.
204 - No Content	Everything worked as expected - however the server will not send a response.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The authorization was successful, but the user doesn't have access to this resource.
404 - Not Found	The requested resource doesn't exist.
422 - Unprocessable Entity	The request was valid, but the options provided resulted in a request that could not be processed.
429 - Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

Response Object

{
  "result": {
    "success": boolean, // True if the request succeeded. Will result in a 2xx status code.
    "httpCode": integer, // The HTTP status code for the response.
    "errorCode": string, // The error code for the error, if any.
    "errorMessage": string // A human readable error message describing the error that occurred, if any.
  },
  "content": any // The request API response.
}