Vector Database

Find Record records semantically furthest from a text query, scoped to one space.

Inverse of /similar: returns records whose embedded text fields are most * DISTANT from the query (cosine distance, descending). Same filter/scope rules as * /similar. Note: HNSW indexes do not accelerate distance-DESC queries; outlier * ranking is closer to a full scan over the filtered candidate set.

get/record/vector/outliers

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/record/vector/outliers
Auth: HTTP bearer

Query parameters

space_idinteger required

Example:123

Tenant scope. Custom module derived from space.custom_module_id.

querystring required

Example:premium wireless headphones

Free-text query to embed; ranking returns records UNLIKE this. Max 4000 characters.

limitinteger

Example:20

filterstring

Example:status=active

Filter expression. Mutually exclusive with segment_id.

segment_idinteger

Example:789

ID of a saved segment whose filter to apply. Mutually exclusive with filter.

max_distancenumber float

Example:0.5

Cosine-distance floor in [0, 2]. Records whose best embedding is CLOSER than this are dropped.

Response

Records ranked by descending cosine distance.

totalCandidatesinteger

queryTimeMsinteger

Example response

{
  "results": [
    {
      "recordId": 99887,
      "distance": 0.91,
      "record": {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "createdUserId": 42,
        "statusSystemId": 42,
        "statusId": 42,
        "spaceId": 42,
        "featuredImageId": 42,
        "files": [
          1
        ],
        "labels": [
          1
        ],
        "boostId": "string",
        "customFieldsValues": [
          {
            "id": 42,
            "created": "2026-01-15T09:30:00Z",
            "valueWysiwyg": "string",
            "valueInt": 1,
            "valueFloat": 1.5,
            "valueDatetime": "2026-01-15T09:30:00Z",
            "valueModule": "string",
            "value": "string",
            "fileId": 42,
            "customFieldInputId": 42,
            "module": "activities",
            "table": "string",
            "entityId": 42,
            "customFieldInputName": "Sample customFieldInputName",
            "selected": "string",
            "ipAddress": "string",
            "translatable": true,
            "translations": {
              "en": {
                "field1": "translation1",
                "field2": "translation2"
              },
              "it": {
                "field1": "translation1",
                "field2": "translation2"
              },
              "cs": {
                "field1": "translation1",
                "field2": "translation2"
              }
            }
          }
        ]
      }
    }
  ],
  "totalCandidates": 8000,
  "queryTimeMs": 38
}

Changes

No recorded changes to this operation across all 1 revision of this API.