Send a message to the chatbot and receive the assistant reply, grounded in the selected Knowledge Base.

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

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

messagestring

The user message / question.

historyarray of objects

Prior turns as { role, content } pairs.

collection_idsarray of strings

KB collection ids to ground in. Falls back to the API key config when omitted.

kb_onlyboolean

When true (the default), answer strictly from the KB.

include_citationsboolean

Whether to return page-level citations.

Response

Response Body

replystringThe assistant reply text.

citationsarray of objectsPage-level KB citations.

usageobjectModel token usage.

modelstring | nullModel that produced the reply.

Request

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

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

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

Credentials

Authorization

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

Response · 201

{
  "data": {
    "reply": "string",
    "citations": [],
    "usage": {},
    "model": "string"
  }
}