Ingest up to 100 inline text documents as a single async task.

POSThttps://staging.softsolz.uk/api/v1/services/smart-chat/kb/documents/import/batch

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

collection_idstring

Target collection id.

documentsarray of objects

Inline documents, e.g. { file_name, text }. Serialized body must be <= 200KB.

folderstring | null

Optional folder.

tagsarray of strings

Optional tags.

Response

Response Body

task_idstringThe enqueued task id.

acceptedintegerNumber of documents enqueued.

statusstringInitial task status.

Request

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

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

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

Credentials

Authorization

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

Response · 201

{
  "data": {
    "task_id": "string",
    "accepted": 0,
    "status": "string"
  }
}