CoffeeHouse Error Codes

CoffeeHouse Error Codes

And error arises whenever success is false and a error object is returned within the results which contains a type property followed by a error_code and message property.
{
  "success":false,
  "response_code":401,
  "error":{
    "error_code":0,
    "type":"CLIENT",
    "message":"Unauthorized Access, Authentication is required"
  }
}

CoffeeHouse Error codes

Error CodeMessageObsoleteDescription
-1Internal Server ErrorfalseThere was an unexpected error while processing your request, this is most likely a server issue/bug
0Generic ErrorfalseThis is a generic error from the API, read the message for more details.
1Missing parameter 'session_id'falseThe server was expecting the parameter ‘session_id’ which was not provided by the client
2Missing parameter ‘input’falseThe server was expecting the parameter ‘input’ which was not provided by the client
3Parameter 'input' contains an invalid valuefalseThe parameter ‘input’ contains an invalid value, the value cannot be empty.
4The session was not foundfalseThe requested session could not be found on the server
5The session is no longer availablefalseThe requested session has expired or an error has raised which enabled the session to no longer be available
6Max quota reachedfalseYou reached the quota limit of the method/resource, if you need more then upgrade your subscription plan
7The given language cannot be identifiedfalseThe given language code is not a valid ISO 639-1 Language code/language name that the server is willing to accept.
8Session cannot be created, service unavailablefalseThe session cannot be created because CoffeeHouse is temporarily unavailable. If this issues continues then report it to support.
9This session does not contain any attributesfalseYou are attempting to get the session attributes of a session that does not contain any attributes, likely an old session.
10RESERVEDtrueThis error code will not be returned, it's reserved for a future update.
11Invalid Base64 DatafalseThe base64 data you provided is not valid or malformed
12Unsupported File TypefalseThe file you tried to upload to the API is not supported by the method
13Service temporarily unavailable (CoffeeHouse-Utils)falseThe service is temporarily unavailable because our internal software CoffeeHouse-Utils is not available, if this issue continues then report it to support.
14Missing file upload or data field 'image'falseThe API acknowledges that you are attempting to upload a file but does not see any data for the file either in the body request or as a parameter
15Invalid generalization sizefalseThe value you requested for the generalization size is not applicable and invalid, it should be number but not less than 1
16Exceeded max generalization sizefalseThe value you entered for the generalization size is more than what your subscription allows
17Missing generalization size parameterfalseThe expected parameter 'generalization_size' is missing
18Generalization table not foundfalseThe requested generalization table provided via the 'generalization_id' parameter was not found
19Generalization not applicable to this methodfalseThis method cannot generalize the results
20Missing parameter 'input'falseThe expected parameter 'input' is missing
21'input' exceeds the limitfalseThe 'input' parameter exceeds the limit that your subscription allows
22Input cannot be emptyfalseThe given input cannot be empty
23The requested language source is not supportedfalseThe requested language source has been identified but it's not supported by this method yet
24The given input cannot be processedfalseThe cannot process the given input due to internal server errors, report this issue to support.