🧠/match-products
Available at https://api.theproductllm.com/match-products
Our /match-products endpoint matches two products based on the text provided, using the selected AI model.
Required Parameters:
product_left: string. required. Provide a JSON object of your supplier product with key value pairs such as {'title':'value'}. You must define the product title under the 'title' key. You can specify familiar or unfamiliar keys. Familiar keys such as 'code', 'brand', 'description', and 'price' will be added under their own key value pair. Do not use the 'id' key for product_left. All other key value pairs will be added to the 'description' key value pair. See Product Field for specifics.
product_right: string. required. Provide a JSON object of a potential matching product, with the same key value pair options as product_left, plus 'id' for the listing id, if available. See Product Field, including tips.
Optional Parameters:
model: string. There is currently only one model available, 'theproductllm-mini,' because larger models are not achieving enough benefit over their cost. Defaults to theproductllm-mini.
cleaning_pipeline: string. If your product data is from a source that requires custom cleaning, you can specify your cleaning pipeline here. For example, the Amazon API catalog responses contain many tokens and we've selected the best attributes to keep. To use this cleaning pipeline, specify "amazon_api_catalog_item". Current cleaning pipeline options:
"amazon_api_catalog_item:" To use this, make sure the Amazon catalog item payload is in the description field as a JSON object. "summaries," "attributes," and "identifiers" should be available in the first level of JSON keys
import requests
response = requests.post(
"https://api.theproductllm.com/search-products",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={
"product_left": {
"title":"This is a product title",
"description":"This is a product description"
}
"product_right": {
"title": "This is a product title",
"description": "This is a product description",
"id":"B0053XNKFQ"
}
}
)
print(response.json())
Response:
{
"match": "yes/no",
"certainty": "medium",
"tokens": 1,
"usage": <Usage Object>
"cost": 0.000112
}Last updated