The Visually Similar Products algorithm surfaces products that look like the one the shopper is currently viewing. It compares product images using a multimodal AI model, refined with light product metadata, and performs optimally on category and product detail pages in visually-driven verticals such as fashion and home décor.
Endpoint
GET https://recommendation.api.useinsider.com/v2/visually-similar
Visit our Postman collection to test this request.
Query Parameters
Parameter | Sample Value | Description | Data Type | Required |
|---|---|---|---|---|
partnerName | mybrand | Partner Identifier assigned by Insider One. You can use PartnerID as well. | String | Yes |
locale | us_US | Locale of requested product catalog | String | Yes |
productId | 1068 | The reference product for which the complement is computed | String | Yes |
currency | USD | Product currency. If no value is set, the default currency in your settings is used. | String | No |
size | 10 | Response items. Valid values are 0 to 100. | Integer | No |
categoryList | [“Clothes”] | Category filter of the products | Array | No |
userId | a1b2c3d4 | User identifier; enables personalization boosts when provided | String | No |
platform | web | Requested platform (default: web) | Enum | No |
details | true | Adds details to the products of the response | Boolean | No |
excludeVariants | true | Hides color/size variants of the same base product | Boolean | No |
shuffle | false | Shuffles the products of the response | Boolean | No |
filter | [in_stock][=][true] | Restricts results by fields such as price, brand, color, gender, in_stock, or category | String | No |
hp | true | Hyper-personalization flag. Re-ranks results using the shopper's attribute preferences | Boolean | No |
getGroupProducts | true | Returns all color/size variants grouped under each recommended product | Boolean | No |
groupProductsFields | product_attributes.color,price | Comma-separated list of fields to include in the grouped variants; products missing any listed field are dropped | String | No |
getAllGroupProductsFields | true | Returns all variant fields without dropping products for missing fields; automatically enables getGroupProducts | Boolean | No |
excludeViewDay | 30 | Days before excluding previously viewed products | Integer | No |
excludeViewItem | 100 | Number of viewed products to exclude | Integer | No |
excludePurchaseDay | 30 | Days before excluding previously purchased products | Integer | No |
excludePurchaseItem | 100 | Number of purchased products to exclude | Integer | No |
Sample Request
The sample below shows a request to Visually Similar Products, the algorithm that suggests items frequently bought or viewed alongside the anchor product.
https://recommendation.api.useinsider.com/v2/visually-similar?partnerName={PartnerName}&locale={Locale}&productId={ABC123}&size=3Sample Response
{
"success": true,
"total": 3,
"types": { "vs": 3 },
"data": [
"649517_49890",
"568334_49053",
"639714_49677"
]
}Fallback Algorithms
When Visually Similar Products results are insufficient, these algorithms fill the response:
Viewed Together
Most Popular Items in Category
Most Popular Items