Skip to main content
POST
/
preview
/
retail-media
/
chatbot-catalogs
/
{catalogid}
/
product-recommendations
/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations
curl --request POST \
  --url https://api.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "messages": [
        {
          "botMessage": {
            "closing": "<string>",
            "opening": "<string>",
            "productRecos": [
              {
                "rationale": "<string>",
                "brand": "<string>",
                "currency": "<string>",
                "description": "<string>",
                "imageUrl": "<string>",
                "name": "<string>",
                "price": 123,
                "url": "<string>"
              }
            ]
          },
          "userMessage": "<string>"
        }
      ]
    },
    "type": "InbotDiscussion"
  }
}
'
import requests

url = "https://api.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations"

payload = { "data": {
"attributes": { "messages": [
{
"botMessage": {
"closing": "<string>",
"opening": "<string>",
"productRecos": [
{
"rationale": "<string>",
"brand": "<string>",
"currency": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"price": 123,
"url": "<string>"
}
]
},
"userMessage": "<string>"
}
] },
"type": "InbotDiscussion"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
attributes: {
messages: [
{
botMessage: {
closing: '<string>',
opening: '<string>',
productRecos: [
{
rationale: '<string>',
brand: '<string>',
currency: '<string>',
description: '<string>',
imageUrl: '<string>',
name: '<string>',
price: 123,
url: '<string>'
}
]
},
userMessage: '<string>'
}
]
},
type: 'InbotDiscussion'
}
})
};

fetch('https://api.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations', 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.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations",
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([
'data' => [
'attributes' => [
'messages' => [
[
'botMessage' => [
'closing' => '<string>',
'opening' => '<string>',
'productRecos' => [
[
'rationale' => '<string>',
'brand' => '<string>',
'currency' => '<string>',
'description' => '<string>',
'imageUrl' => '<string>',
'name' => '<string>',
'price' => 123,
'url' => '<string>'
]
]
],
'userMessage' => '<string>'
]
]
],
'type' => 'InbotDiscussion'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations"

payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"messages\": [\n {\n \"botMessage\": {\n \"closing\": \"<string>\",\n \"opening\": \"<string>\",\n \"productRecos\": [\n {\n \"rationale\": \"<string>\",\n \"brand\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"price\": 123,\n \"url\": \"<string>\"\n }\n ]\n },\n \"userMessage\": \"<string>\"\n }\n ]\n },\n \"type\": \"InbotDiscussion\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
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.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"messages\": [\n {\n \"botMessage\": {\n \"closing\": \"<string>\",\n \"opening\": \"<string>\",\n \"productRecos\": [\n {\n \"rationale\": \"<string>\",\n \"brand\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"price\": 123,\n \"url\": \"<string>\"\n }\n ]\n },\n \"userMessage\": \"<string>\"\n }\n ]\n },\n \"type\": \"InbotDiscussion\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.criteo.com/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"attributes\": {\n \"messages\": [\n {\n \"botMessage\": {\n \"closing\": \"<string>\",\n \"opening\": \"<string>\",\n \"productRecos\": [\n {\n \"rationale\": \"<string>\",\n \"brand\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"price\": 123,\n \"url\": \"<string>\"\n }\n ]\n },\n \"userMessage\": \"<string>\"\n }\n ]\n },\n \"type\": \"InbotDiscussion\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "attributes": {
      "botMessage": {
        "closing": "<string>",
        "opening": "<string>",
        "productRecos": [
          {
            "rationale": "<string>",
            "brand": "<string>",
            "currency": "<string>",
            "description": "<string>",
            "imageUrl": "<string>",
            "name": "<string>",
            "price": 123,
            "url": "<string>"
          }
        ]
      },
      "userMessage": "<string>"
    },
    "type": "Message"
  },
  "errors": [
    {
      "code": "<string>",
      "instance": "<string>",
      "traceId": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

catalogid
string
required

the identifier of the catalog to query

Body

application/json

an API recommendation message

data
InbotDiscussionDataInstanceModel · object
required

an API recommendation request

Response

200 - application/json

Successful Response

error message

data
MessageDataInstanceModel · object | null

an API answer message

errors
MessageError · object[] | null