Sign InBook a Demo
Support

Search APIs

POSTVisual Search

Search products by uploading an image.

POSThttps://api.catalogix.ai/v1/visual-search

Authorization

Authorizationstringrequiredheader
Bearer token, Bearer <token>. Create one under Tokens in your workspace.

Query parameters

store_uuidstringrequired
Store identifier
Example: 69b3a770f5006c4b0be47c85
offsetintegerdefault: 0
Pagination offset
limitintegerdefault: 100
Maximum number of results
filtersstringdefault: "{}"
Filters as a JSON-encoded string. Example: '{"Category": "Tops", "Color": "Blue"}'. Must be valid JSON if provided.
Example: {"Category": "Tops", "Color": "Blue"}

Headers

X-Request-Idstring
Optional trace ID

Body

multipart/form-data required

imagefilerequired
Image file for visual search

Responses

200Visual search results
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject[]
List of visually similar products with relevance scores.
Item fields
product_codestring
Example: SKU001
scorenumber
Example: 0.92
image_urlstring
Example: https://cdn.example.com/img1.jpg
400Validation error
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
500Internal server error
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Internal server error. Please contact support@catalogix.ai
502Downstream service unavailable
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error

Something missing or unclear? Write to support@streamoid.com.

esc