Image Recognition API Documentation

Error codes

Here you can learn about error codes returned by our REST Image Recognition API, including their causes, and solutions for each one.

Note that, in addition to the generic HTTP status codes, we also return much more specific and informative error codes in the JSON response. All the specific error responses follow the same JSON format:

 

We strongly recommend that you parse only the code field. The message field is intended solely for debugging purposes, and client services are not expected to parse it.

 


Client error codes

TOKEN_MISSING

  • Cause:The token parameter is missing. We do not know which collection you want to search.
  • Solution:Add the token parameter. Consider reading “Where do I get my token?
  • HTTP Status code:
  • API response:

TOKEN_WRONG

  • Cause:The token parameter has a wrong syntax. It should be a 16 alpha-numeric string.
  • Solution:Use the right token. Consider reading “Where do I get my token?
  • HTTP Status code:
  • API response:

TOKEN_INVALID

  • Cause:The token parameter is invalid. It is a 16 alpha-numeric string, but it does not exist.
  • Solution:Use the right token. Consider reading “Where do I get my token?
  • HTTP Status code:
  • API response:

IMAGE_MISSING

  • Cause:The image parameter is missing. We need a query image to perform a recognition.
  • Solution:Add the image parameter.
  • HTTP Status code:
  • API response:

IMAGE_TOO_LARGE

  • Cause:The query image is too large.
  • Solution:Send a smaller image. Follow our guidelines for query images.
  • HTTP Status code:
  • API response:

IMAGE_TOO_SMALL

  • Cause:The query image dimensions are too small.
  • Solution:Send a bigger image. Follow our guidelines for query images.
  • HTTP Status code:
  • API response:

IMAGE_TRANSPARENCY

  • Cause:The query image has alpha transparency. We do not support that.
  • Solution:Send only supported formats. Follow our guidelines for query images.
  • HTTP Status code:
  • API response:

IMAGE_NO_DETAILS

  • Cause:The query image has not enough details to perform a recognition. Probably it was a blank image, or maybe a picture taken at a wall/floor with no details/patterns/objects on it.
  • Solution:If the picture was taken by a user, suggest her to take a better picture of the object.Otherwise, follow our guidelines for query images.
  • HTTP Status code:
  • API response:

IMAGE_NOT_LOADED

  • Cause:The query image could not be loaded. Probably it is corrupted, or in an unsupported format.
  • Solution:Follow our guidelines for query images.
  • HTTP Status code:
  • API response:

SCAN_QUOTA_EXCEEDED

  • Cause:You have reached your monthly visual scans limit.
  • Solution:Upgrade you plan.
  • HTTP Status code:
  • API response:

 


Server error codes

SERVER_ERROR

  • Cause:We are sorry, it’s our fault!Our service had an internal error and could not fulfill your request. Most probably your recognition query went to a faulty component that was restarted, or was too slow to respond. It is a temporary thing, and the service will be back again in a few seconds.

    Be sure that we are already working on fixing the problem! Our service has logged the error, saved the full stacktrace, and notified us in real-time.

  • Solution:Try again in a few seconds.Should the problem persist, contact us.
  • HTTP Status code:
  • API response: