POST
/
recs
Get Recommendations
curl --request POST \
  --url https://api.joinrefine.io/recs \
  --header 'Content-Type: application/json' \
  --header 'REFINE_API_KEY: <api-key>' \
  --data '{
  "organizationId": "f2c320fc-1234-4567-8901-84c87f6b4c52",
  "catalogId": "1e2f3d4c-5678-9012-3456-9baaf2a08e3f",
  "productId": "GUCCI12345",
  "topK": 12,
  "visualWeight": 0.5,
  "filters": [
    {
      "field": "price",
      "operator": "eq",
      "value": "<string>"
    }
  ],
  "includeMetadata": true
}'
{
  "status": "success",
  "results": [
    {
      "productId": "GUCCI98765",
      "metadata": {
        "name": "GG Denim Shirt",
        "price": 180,
        "brand": "Gucci",
        "color": "blue"
      }
    }
  ]
}

Authorizations

REFINE_API_KEY
string
header
required

API key for authentication

Body

application/json

Response

200
application/json

Product recommendations

The response is of type object.