Skip to main content
POST
/
visual-search
Visual Search
curl --request POST \
  --url https://api.catalogix.ai/v1/visual-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file'
{
  "status": {
    "code": 0,
    "message": "SUCCESS",
    "request_id": "8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312"
  },
  "data": [
    {
      "product_code": "SKU001",
      "score": 0.92,
      "image_url": "https://cdn.example.com/img1.jpg"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamoid.com/llms.txt

Use this file to discover all available pages before exploring further.

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.