Skip to main content
POST
Get Recommendations

Authorizations

REFINE_API_KEY
string
header
required

API key for authentication

Body

application/json
organizationId
string<uuid>
required

Organization ID

Example:

"f2c320fc-1234-4567-8901-84c87f6b4c52"

catalogId
string<uuid>
required

Catalog ID

Example:

"1e2f3d4c-5678-9012-3456-9baaf2a08e3f"

productId
string
required

Product ID to get recommendations for (cannot be empty)

Example:

"GUCCI12345"

topK
integer
required

Number of recommendations to return

Example:

12

visualWeight
number<float>

Weight for visual similarity (0,1]. Default: 1.0

Required range: 0 < x <= 1
Example:

0.5

filters
object[]

Optional filters to apply

includeMetadata
boolean

Whether to include product metadata. Default: true

Example:

true

Response

Product recommendations

status
enum<string>
Available options:
success
Example:

"success"

results
object[]