SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Knowledge Hub

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

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/smart-chat/kb/documents \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": [
    {
      "id": "d0000000-0000-0000-0000-000000000001",
      "collection_id": "c0000000-0000-0000-0000-000000000001",
      "file_name": "refund-policy.pdf",
      "mime": "application/pdf",
      "page_count": 12,
      "status": "ready",
      "tags": [
        "policy"
      ],
      "created_at": "2026-06-01T09:00:00.000Z",
      "updated_at": "2026-06-01T09:05:00.000Z"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}