Search Products

Search Products

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",
      "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"
  }
}
'

import requests

url = "https://api.joinrefine.io/search"

payload = {
    "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",
            "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"
    }
}
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',
    query: 'blue denim jacket',
    topK: 24,
    visual_weight: 0.8,
    similarity_threshold: 0.25,
    filters: [{field: 'price', 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'
    }
  })
};

fetch('https://api.joinrefine.io/search', 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/search",
  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',
    'query' => 'blue denim jacket',
    'topK' => 24,
    'visual_weight' => 0.8,
    'similarity_threshold' => 0.25,
    'filters' => [
        [
                'field' => 'price',
                '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'
    ]
  ]),
  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/search"

	payload := strings.NewReader("{\n  \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n  \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\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/search")
  .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  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.joinrefine.io/search")

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  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "results": [
    {
      "productId": "GUCCI12345",
      "score": 0.8834,
      "metadata": {
        "name": "GG Denim Jacket",
        "brand": "Gucci",
        "price": 198,
        "color": "blue",
        "rank": "BOOST"
      }
    }
  ]
}

{
  "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"
}

POST

Search Products

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",
      "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"
  }
}
'

import requests

url = "https://api.joinrefine.io/search"

payload = {
    "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",
            "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"
    }
}
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',
    query: 'blue denim jacket',
    topK: 24,
    visual_weight: 0.8,
    similarity_threshold: 0.25,
    filters: [{field: 'price', 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'
    }
  })
};

fetch('https://api.joinrefine.io/search', 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/search",
  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',
    'query' => 'blue denim jacket',
    'topK' => 24,
    'visual_weight' => 0.8,
    'similarity_threshold' => 0.25,
    'filters' => [
        [
                'field' => 'price',
                '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'
    ]
  ]),
  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/search"

	payload := strings.NewReader("{\n  \"organizationId\": \"f2c320fc-1234-4567-8901-84c87f6b4c52\",\n  \"catalogId\": \"1e2f3d4c-5678-9012-3456-9baaf2a08e3f\",\n  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\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/search")
  .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  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.joinrefine.io/search")

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  \"query\": \"blue denim jacket\",\n  \"topK\": 24,\n  \"visual_weight\": 0.8,\n  \"similarity_threshold\": 0.25,\n  \"filters\": [\n    {\n      \"field\": \"price\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"user_analytics\": {\n    \"session_id\": \"01HWEXYZ123456789\",\n    \"ip_address\": \"24.161.52.129\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "results": [
    {
      "productId": "GUCCI12345",
      "score": 0.8834,
      "metadata": {
        "name": "GG Denim Jacket",
        "brand": "Gucci",
        "price": 198,
        "color": "blue",
        "rank": "BOOST"
      }
    }
  ]
}

{
  "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

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"

query

string

required

Search query (automatically converted to lowercase)

Example:

"blue denim jacket"

topK

integer

required

Number of results to return

Example:

24

visual_weight

number<float>

required

Weight for visual similarity (0,1]

Required range: 0 < x <= 1

Example:

0.8

similarity_threshold

number<float>

required

Minimum similarity score for results [0,1]

Required range: 0 <= x <= 1

Example:

0.25

filters

object[]

Optional filters to apply

Show child attributes

user_analytics

object

Optional analytics data

Show child attributes

Response

Search results

status

enum<string>

Available options:

success

Example:

"success"

results

object[]

Show child attributes

Delete Multiple Products Get Recommendations

Getting Started

Catalog Operations

Product Operations

Search

Recommendations

Catalog Operations

Product Operations

Search

Recommendations

Authorizations

Body

Response