Find Similar – Lightfast API

Find content similar to a given document or URL using vector similarity, entity overlap, and cluster analysis.

Authorization

apiKey

AuthorizationBearer <token>

Use your Lightfast API key (sk-lf-...) as the bearer token. Optionally include X-Workspace-ID header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

Document ID to find similar content for

url?string

URL to find similar content for (alternative to id)

Formaturi

limit?integer

Maximum number of similar items to return (1-50, default: 10)

Default10

Range1 <= value <= 50

threshold?number

Minimum similarity score 0-1 (default: 0.5)

Default0.5

Range0 <= value <= 1

sameSourceOnly?boolean

Only return results from the same source type (default: false)

Defaultfalse

excludeIds?array<>

Array of IDs to exclude from results

filters?

Optional filters to scope results

Response Body

`application/json`

curl -X POST "https://lightfast.ai/v1/findsimilar" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "source": {
      "id": "string",
      "title": "string",
      "type": "string"
    },
    "similar": [
      {
        "id": "string",
        "title": "string",
        "source": "string",
        "type": "string",
        "url": "string",
        "occurredAt": "2019-08-24T14:15:22Z",
        "snippet": "string",
        "score": 0,
        "similarity": 0,
        "entityOverlap": 0
      }
    ]
  },
  "meta": {
    "total": 0,
    "took": 0
  },
  "requestId": "string"
}

Empty

Authorization

Request Body

Response Body

200application/json

400

401

500

`application/json`