Send Search Query

The imageBase64 or text fields are used to send the user query—either as a base64-encoded image or as a text string containing the user’s search.

To send a simple search query, the query object must include one of the following:

• text (mandatory) : A textual query string
  Used only for Semantic Search campaigns
• imageBase64 (mandatory): A base64-encoded image string
  Supported formats: JPG, PNG, GIF, BMP, HEIC
  Maximum file size: 5 MB
  Used only for Visual Search campaigns

Example: Sending a text query

{
  "query": {
    "text": "dress",
    "pagination": {
      "numItems": 24,
      "offset": 0
    }
  }
}

This query returns the first 24 results for "dress".

Example: Sending an image query

{
  "query": {
    "imageBase64": "<base64 encoded image>",
  }
}

This query returns relevant products based on their image.

📌

Notes:

• The pagination field must be included with each text query.
• imageBase64 queries do not support pagination.