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",
"value": "<string>"
}
],
"includeMetadata": true
}
'import requests
url = "https://api.joinrefine.io/recs"
payload = {
"organizationId": "f2c320fc-1234-4567-8901-84c87f6b4c52",
"catalogId": "1e2f3d4c-5678-9012-3456-9baaf2a08e3f",
"productId": "GUCCI12345",
"topK": 12,
"visualWeight": 0.5,
"filters": [
{
"field": "price",
"value": "<string>"
}
],
"includeMetadata": True
}
headers = {
"REFINE_API_KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {REFINE_API_KEY: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: 'f2c320fc-1234-4567-8901-84c87f6b4c52',
catalogId: '1e2f3d4c-5678-9012-3456-9baaf2a08e3f',
productId: 'GUCCI12345',
topK: 12,
visualWeight: 0.5,
filters: [{field: 'price', value: '<string>'}],
includeMetadata: true
})
};
fetch('https://api.joinrefine.io/recs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinrefine.io/recs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organizationId' => 'f2c320fc-1234-4567-8901-84c87f6b4c52',
'catalogId' => '1e2f3d4c-5678-9012-3456-9baaf2a08e3f',
'productId' => 'GUCCI12345',
'topK' => 12,
'visualWeight' => 0.5,
'filters' => [
[
'field' => 'price',
'value' => '<string>'
]
],
'includeMetadata' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"REFINE_API_KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.joinrefine.io/recs"
payload := strings.NewReader("{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("REFINE_API_KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.joinrefine.io/recs")
.header("REFINE_API_KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinrefine.io/recs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["REFINE_API_KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"results": [
{
"productId": "GUCCI98765",
"metadata": {
"name": "GG Denim Shirt",
"price": 180,
"brand": "Gucci",
"color": "blue"
}
}
]
}{
"status": 123,
"message": "<string>",
"time": "2023-11-07T05:31:56Z",
"method": "<string>",
"url": "<string>"
}{
"status": 401,
"message": "Unauthorized",
"time": "2024-06-14T19:21:00Z",
"method": "GET",
"url": "/organizations/a8cd2722-1234-4567-9abc-def123456789/catalogs"
}{
"status": 403,
"message": "Forbidden",
"time": "2024-06-14T19:21:00Z",
"method": "POST",
"url": "/search"
}{
"status": 500,
"message": "Internal Server Error",
"time": "2024-06-14T19:21:00Z",
"method": "POST",
"url": "/recs"
}Recommendations
Get Recommendations
Get product recommendations based on visual similarity
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",
"value": "<string>"
}
],
"includeMetadata": true
}
'import requests
url = "https://api.joinrefine.io/recs"
payload = {
"organizationId": "f2c320fc-1234-4567-8901-84c87f6b4c52",
"catalogId": "1e2f3d4c-5678-9012-3456-9baaf2a08e3f",
"productId": "GUCCI12345",
"topK": 12,
"visualWeight": 0.5,
"filters": [
{
"field": "price",
"value": "<string>"
}
],
"includeMetadata": True
}
headers = {
"REFINE_API_KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {REFINE_API_KEY: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: 'f2c320fc-1234-4567-8901-84c87f6b4c52',
catalogId: '1e2f3d4c-5678-9012-3456-9baaf2a08e3f',
productId: 'GUCCI12345',
topK: 12,
visualWeight: 0.5,
filters: [{field: 'price', value: '<string>'}],
includeMetadata: true
})
};
fetch('https://api.joinrefine.io/recs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinrefine.io/recs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organizationId' => 'f2c320fc-1234-4567-8901-84c87f6b4c52',
'catalogId' => '1e2f3d4c-5678-9012-3456-9baaf2a08e3f',
'productId' => 'GUCCI12345',
'topK' => 12,
'visualWeight' => 0.5,
'filters' => [
[
'field' => 'price',
'value' => '<string>'
]
],
'includeMetadata' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"REFINE_API_KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.joinrefine.io/recs"
payload := strings.NewReader("{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("REFINE_API_KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.joinrefine.io/recs")
.header("REFINE_API_KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinrefine.io/recs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["REFINE_API_KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n \"productId\": \"GUCCI12345\",\n \"topK\": 12,\n \"visualWeight\": 0.5,\n \"filters\": [\n {\n \"field\": \"price\",\n \"value\": \"<string>\"\n }\n ],\n \"includeMetadata\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"results": [
{
"productId": "GUCCI98765",
"metadata": {
"name": "GG Denim Shirt",
"price": 180,
"brand": "Gucci",
"color": "blue"
}
}
]
}{
"status": 123,
"message": "<string>",
"time": "2023-11-07T05:31:56Z",
"method": "<string>",
"url": "<string>"
}{
"status": 401,
"message": "Unauthorized",
"time": "2024-06-14T19:21:00Z",
"method": "GET",
"url": "/organizations/a8cd2722-1234-4567-9abc-def123456789/catalogs"
}{
"status": 403,
"message": "Forbidden",
"time": "2024-06-14T19:21:00Z",
"method": "POST",
"url": "/search"
}{
"status": 500,
"message": "Internal Server Error",
"time": "2024-06-14T19:21:00Z",
"method": "POST",
"url": "/recs"
}Authorizations
API key for authentication
Body
application/json
Organization ID
Example:
"f2c320fc-1234-4567-8901-84c87f6b4c52"
Catalog ID
Example:
"1e2f3d4c-5678-9012-3456-9baaf2a08e3f"
Product ID to get recommendations for (cannot be empty)
Example:
"GUCCI12345"
Number of recommendations to return
Example:
12
Weight for visual similarity (0,1]. Default: 1.0
Required range:
0 < x <= 1Example:
0.5
Optional filters to apply
Show child attributes
Show child attributes
Whether to include product metadata. Default: true
Example:
true
⌘I