Create a new chat thread.

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

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

titlestring

Thread title (defaults to "New chat").

visibilitystring

Visibility (default "private"). "shared" requires shared_user_ids and/or shared_role_ids.

shared_user_idsarray of integers

Member ids to share with (required when visibility=shared and no shared_role_ids).

shared_role_idsarray of integers

Role ids to share with (when visibility=shared).

Response

Response Body

idstringThread id.

titlestringThread title.

visibilitystringWho can see the thread.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

shared_user_idsarray of integersMember ids the thread is shared with (visibility=shared only).

shared_role_idsarray of integersRole ids the thread is shared with (visibility=shared only).

Request

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

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

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

Credentials

Authorization

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

Response · 201

{
  "data": {
    "id": "string",
    "title": "string",
    "visibility": "string",
    "created_at": "string",
    "updated_at": "string",
    "shared_user_ids": [],
    "shared_role_ids": []
  }
}