Semantic search across the Knowledge Base. Returns top-K matched chunks with citations and similarity scores.

POSThttps://staging.softsolz.uk/api/v1/services/smart-chat/kb/search

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

querystring

The search query.

top_kinteger

Max chunks to return (default 6).

document_idsarray of strings

Restrict to specific document ids.

tagsarray of strings

Restrict to documents with these tags.

foldersarray of strings

Restrict to these folders.

Response

Response Body

hitsarray of objectsMatched chunks with file_name, page_number, score, snippet, text.

modelstring | nullEmbedding model used.

usage_tokensinteger | nullEmbedding tokens consumed by the query.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.smartChat.searchKb({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "hits": [],
    "model": "string",
    "usage_tokens": 0
  }
}