API referencerecommend
Personalized recommendations
Scores caller-supplied candidates given engagement history. Requires history and item_texts (same shape as personalized /rerank).
domain=uiux (default) selects the UI/UX recommendation model. Use POST /rerank for general affinity / history rerank.
Authorization
ApiKeyAuth X-API-Key<token>
In: header
Query Parameters
relative_to_entity_id*string
Anchor user / entity id for the recommendation context.
in_terms_of_entity_type*string
Entity type context.
Value in
"content" | "place" | "brand" | "user" | "website" | "file"domain?string
Recommendation domain. Default uiux.
Default
"uiux"Value in
"uiux"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/recommend?relative_to_entity_id=string&in_terms_of_entity_type=content" \ -H "Content-Type: application/json" \ -d '{ "candidates": [ { "url": "http://example.com", "type": "image", "domain": "restaurants" } ], "history": [ null ] }'{
"results": [
{
"id": "string",
"name": "string",
"description": "string",
"url": "http://example.com",
"ref": "string",
"type": "content",
"linked_content": [
{
"id": "string",
"title": "string",
"description": "string",
"url": "http://example.com",
"content": "string",
"skip_url_fetch": false,
"skip_media_enrich": false,
"type": "image",
"domain": "restaurants",
"ref": "string"
}
],
"linked_entities": [
{
"id": "string",
"name": "string",
"description": "string",
"url": "http://example.com",
"ref": "string",
"type": "content",
"linked_content": [
{
"id": "string",
"title": "string",
"description": "string",
"url": "http://example.com",
"content": "string",
"skip_url_fetch": false,
"skip_media_enrich": false,
"type": "image",
"domain": "restaurants",
"ref": "string"
}
],
"linked_entities": []
}
]
}
]
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}