Get a KB document including processing status.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

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.getKbDocument('<id>');
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"
  }
}