Documentation

Search API v2

This method of the Image Recognition API sends an image recognition request from a client application (such as mobile apps or your own server).

URL
https://search.craftar.net/v2/search
Method
POST
Parameters
  • token: the Token of the collection to be searched.
  • image: the query image, as binary image file in jpeg or png (without transparency) format.
  • app_id: a string identifying the application.
  • version: a string identifying the SDK version.
  • (optional) bboxes: if set to true the response will include bounding boxes. By default it’s false.
  • (optional) embed_custom: if set to true the response custom data will be embedded. Otherwise, it will be sent as an url. By default it’s false. Note that embedding the custom data results in an additional latency. If you need to minimize response times we recommend getting just URLs (i.e. no embedding) and caching the data.
  • (optional) embed_tracking: if set to true the response tracking data will be embedded (if present). Otherwise, it will be sent as an url. By default it’s false.

Note that the parameters must use multipart/form-data encoding.

Request examples

The example uses query image query.jpg, collection token afe34dbe14890fac, App ID com.catchoom.test and SDK version ARSDK-1.

Curl example
Python example

Response fields

The response contains a JSON dictionary with recognized items (objects) ordered by their scores, i.e. the first item has the highest score.

The JSON dictionary has the following fields:

In case of an error, in addition to an appropriate HTTP status code, the service will also return a much more specific and informative error codes in the JSON response. Check the documentation on Error codes in the recognition API for more detailed information.

Response examples

Success
Failure