Skip to main content
POST
/
db
/
recommend
JavaScript
const url = 'https://api.worqhat.com/db/recommend';
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: '{"table":"products","record_id":"123","user_history":["123","456","789"],"strategy":"similar","limit":10,"exclude_ids":["123","456"],"environment":"production"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "success": true,
  "recommendations": [
    {
      "record": {},
      "similarity": 0.823,
      "_meta": {
        "strategy": "similar",
        "source": "single_item"
      }
    }
  ],
  "strategy": "similar",
  "executionTime": 189
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format - "Bearer YOUR_API_KEY"

Body

application/json
​
table
string
required

Table to generate recommendations from

Example:

"products"

​
record_id

Source item ID for item-to-item recommendations

Example:

"123"

​
user_history
string[]

Array of record IDs the user has interacted with

Example:
["123", "456", "789"]
​
strategy
enum<string>
default:similar

Recommendation strategy to use

Available options:
similar,
diverse,
popular
​
limit
number
default:10

Maximum number of recommendations to return

Required range: 1 <= x <= 100
​
exclude_ids
string[]

Record IDs to exclude from recommendations

Example:
["123", "456"]
​
environment
enum<string>

Environment to search in (development, staging, production)

Available options:
development,
staging,
production
Example:

"production"

Response

Recommendations generated successfully

​
success
boolean
Example:

true

​
recommendations
object[]
​
strategy
string

Strategy used for recommendations

Example:

"similar"

​
executionTime
number

Recommendation generation time in milliseconds

Example:

189