curl --request POST \
--url https://api.joinrefine.io/search \
--header 'Content-Type: application/json' \
--header 'REFINE_API_KEY: <api-key>' \
--data '{
"organizationId": "f2c320fc-1234-4567-8901-84c87f6b4c52",
"catalogId": "1e2f3d4c-5678-9012-3456-9baaf2a08e3f",
"query": "blue denim jacket",
"topK": 24,
"visual_weight": 0.8,
"similarity_threshold": 0.25,
"filters": [
{
"field": "price",
"operator": "eq",
"value": "<string>"
}
],
"user_analytics": {
"session_id": "01HWEXYZ123456789",
"ip_address": "24.161.52.129",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
}
}'
{
"status": "success",
"results": [
{
"productId": "GUCCI12345",
"score": 0.8834,
"metadata": {
"name": "GG Denim Jacket",
"brand": "Gucci",
"price": 198,
"color": "blue",
"rank": "BOOST"
}
}
]
}
Search for products using text queries with visual similarity
curl --request POST \
--url https://api.joinrefine.io/search \
--header 'Content-Type: application/json' \
--header 'REFINE_API_KEY: <api-key>' \
--data '{
"organizationId": "f2c320fc-1234-4567-8901-84c87f6b4c52",
"catalogId": "1e2f3d4c-5678-9012-3456-9baaf2a08e3f",
"query": "blue denim jacket",
"topK": 24,
"visual_weight": 0.8,
"similarity_threshold": 0.25,
"filters": [
{
"field": "price",
"operator": "eq",
"value": "<string>"
}
],
"user_analytics": {
"session_id": "01HWEXYZ123456789",
"ip_address": "24.161.52.129",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
}
}'
{
"status": "success",
"results": [
{
"productId": "GUCCI12345",
"score": 0.8834,
"metadata": {
"name": "GG Denim Jacket",
"brand": "Gucci",
"price": 198,
"color": "blue",
"rank": "BOOST"
}
}
]
}
API key for authentication
Search results
The response is of type object
.