The Synerise AI Developer Hub

Welcome to the Synerise AI developer hub. You'll find comprehensive guides and documentation to help you start working with Synerise AI API as quickly as possible, as well as support if you get stuck.
Let's jump right in!

Providing product feed

In order to be able to recommend products Synerise AI needs to know what products are you selling.

The easiest way to do so is just to add the URL link to your product feed in the Settings page of Synerise AI platform.

However, one more option of providing product feed exists. You can use our Product Feed API, which is compatible with Google Content API for Shopping v2.
Please refer to Google Content API for Shopping documentation for details on request formats.

Remember only that, instead of using google api endpoint, you need to use Synerise AI API (i.e. ai-docs.synerise.com)

For example, here is how a sample request to add a product may look in Python.

import requests

# You need to authorize first. Please see Quick start with Synerise AI API
token = ...

product_json = {
{
  "offerId": "product-1",
  "title": "Product title",
  "description": "Product description",
  "link": "http://your-web-page/product-page",
  "imageLink": "http://your-web-page/images/product-image.png",
  "contentLanguage": "pl",
  "targetCountry": "PL",
  "channel": "online",
  "itemGroupId": "product-1-group",
  "color": "green",
  "googleProductCategory": "A supercategory > A subcategory",
  "gtin": "1234567890123",
  "price": {
    "value": "10.23",
    "currency": "PLN"
  }
  # You may provide more information. Check Google Content API for Shopping 
}
  
headers = {'Authorization': 'Bearer ' + token}

requests.post('https://ai-api.synerise.com/content/v2/products',
              json=product_json, headers=headers)

Of course, besides attributes presented in the code above, you can freely add more custom attributes to your product feed.