List Knowledge Base documents.

GEThttps://staging.softsolz.uk/api/v1/services/smart-chat/kb/documents

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.

Query Params

searchstring

Case-insensitive match on file name.

collection_idstring

Filter to one collection.

statusstring

Filter by processing status.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Pagination offset (default 0).

Response

Response Body · array of objects

idstringDocument id.

collection_idstring | nullParent collection id.

file_namestringOriginal file name.

mimestringFile MIME type.

page_countinteger | nullPage count once parsed.

statusstringProcessing status.

tagsarray of stringsDocument tags.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

Request

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

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

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

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": "string",
      "collection_id": "string",
      "file_name": "string",
      "mime": "string",
      "page_count": 0,
      "status": "string",
      "tags": [],
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}