Skip to main content
POST
/
preview
/
recommendation
/
search-conversational
/preview/recommendation/search-conversational
curl --request POST \
  --url https://api.criteo.com/preview/recommendation/search-conversational \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adSetId": 123,
  "conversation": [
    {
      "content": "<string>",
      "role": "<string>"
    }
  ],
  "nbRequestedProducts": 123,
  "partnerId": 123,
  "userId": "<string>",
  "adId": 123,
  "product": {
    "brand": "<string>",
    "category": "<string>",
    "color": "<string>",
    "description": "<string>",
    "name": "<string>",
    "price": {
      "amount": 123,
      "currency": "<string>"
    },
    "productId": "<string>",
    "size": "<string>"
  }
}
'
{
  "extraInfos": [
    123
  ],
  "products": [
    {
      "alternativeClickUrl": "<string>",
      "brand": "<string>",
      "clickUrl": "<string>",
      "description": "<string>",
      "googleCategory": "<string>",
      "hasVariants": true,
      "imageUrl": "<string>",
      "name": "<string>",
      "price": 123,
      "productExternalId": "<string>",
      "relevancyScore": 123,
      "retailPrice": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Conversational recommendation request parameters

adSetId
integer<int32>
required

Id of the AdSet. This field is optional and is resolved automatically for adsets previously configured.

conversation
object[]
required

Conversation between the user and the agent.

nbRequestedProducts
integer<int32>
required

Amount of products to recommend.

partnerId
integer<int32>
required

Id of the partner.

userId
string
required

Used to retrieve user events from Criteo trackers.

adId
integer<int32>

Id of the Ad. This field is optional, it allows to setup Reco controls at Ad level.

product
object

Information about a product used as context for conversational recommendation

Response

200 - application/json

Success

Recommendation response

extraInfos
integer<int32>[] | null

Additional information in case of warnings, errors...

products
object[] | null

Recommended products