Skip to main content
POST
Visual Search

Authorizations

Authorization
string
header
required

Pass the API token as a Bearer token in the Authorization header.

Headers

X-Request-Id
string

Optional trace ID

Query Parameters

store_uuid
string
required

Store identifier

offset
integer
default:0

Pagination offset

limit
integer
default:100

Maximum number of results

filters
string
default:{}

Filters as a JSON-encoded string. Example: '{"Category": "Tops", "Color": "Blue"}'. Must be valid JSON if provided.

Example:

"{\"Category\": \"Tops\", \"Color\": \"Blue\"}"

Body

multipart/form-data
image
file
required

Image file for visual search

Response

Visual search results

status
object
data
object[]

List of visually similar products with relevance scores.