Skip to main content
GET
/
KnowledgeBaseChat
List knowledge base chats
curl --request GET \
  --url https://api.starleads.co/KnowledgeBaseChat \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "datasetIds": [
        "<string>"
      ],
      "datasetNames": [
        "<string>"
      ],
      "connectedAgentCount": 123,
      "llmSettings": {
        "temperature": 123,
        "topP": 123,
        "presencePenalty": 123,
        "frequencyPenalty": 123
      },
      "promptSettings": {
        "similarityThreshold": 123,
        "keywordsSimilarityWeight": 123,
        "topN": 123,
        "prompt": "<string>",
        "opener": "<string>",
        "emptyResponse": "<string>",
        "showQuote": true,
        "rerankModel": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "pageNumber": 123,
  "pageSize": 123
}

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Query Parameters

pageNumber
integer<int32>
default:1

Page number (starts at 1, default: 1).

Required range: x >= 1
pageSize
integer<int32>
default:50

Number of items per page (1 to 100, default: 50).

Required range: 1 <= x <= 100

Response

Success

Paginated response containing knowledge base chats

data
object[]

List of chats for the current page

total
integer<int32>

Total number of items across all pages

pageNumber
integer<int32>

Current page number

pageSize
integer<int32>

Number of items per page