Skip to main content
POST
/
db
/
find-similar
JavaScript
const url = 'https://api.worqhat.com/db/find-similar';
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: '{"table":"products","record_id":"123","limit":10,"threshold":0.7,"exclude_self":true,"target_table":"articles","environment":"production"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "success": true,
  "source_record": {},
  "similar_records": [
    {
      "table": "products",
      "record": {},
      "similarity": 0.891
    }
  ],
  "executionTime": 156
}

Authorizations

Authorization
string
header
required

API key authentication. Format - "Bearer YOUR_API_KEY"

Body

application/json
table
string
required

Table containing the source record

Example:

"products"

record_id
required

ID of the source record

Example:

"123"

limit
number
default:10

Maximum number of similar records to return

Required range: 1 <= x <= 100
threshold
number
default:0.7

Minimum similarity score threshold

Required range: 0 <= x <= 1
exclude_self
boolean
default:true

Whether to exclude the source record from results

target_table
string

Different table to search in (optional)

Example:

"articles"

environment
enum<string>

Environment to search in (development, staging, production)

Available options:
development,
staging,
production
Example:

"production"

Response

Similar records found successfully

success
boolean
Example:

true

source_record
object

The original record used for similarity search

similar_records
object[]
executionTime
number

Search execution time in milliseconds

Example:

156