Skip to main content
PATCH
/
KnowledgeBaseChat
/
{chatId}
Update a knowledge base chat
curl --request PATCH \
  --url https://api.starleads.co/KnowledgeBaseChat/{chatId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Updated KB",
  "datasetIds": [
    "ds_abc123",
    "ds_def456"
  ],
  "llmSettings": {
    "temperature": 0.5
  }
}
'
{
  "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"
}

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

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

Path Parameters

chatId
string
required

ID of the knowledge base chat.

Body

application/json

Partial update for a chat. Only provided fields will be updated

name
string | null

Chat name (if provided: 1-255 chars)

datasetIds
string[] | null

Dataset IDs to connect

llmSettings
object

LLM configuration parameters exposed to the API (excludes model name)

promptSettings
object

RAG prompt configuration

Response

Chat updated successfully

Public representation of a knowledge base chat

id
string

Chat identifier

name
string

Chat name

datasetIds
string[] | null

Connected dataset IDs

datasetNames
string[] | null

Connected dataset names (read-only)

connectedAgentCount
integer<int32> | null

Number of agents using this chat

llmSettings
object

LLM configuration parameters exposed to the API (excludes model name)

promptSettings
object

RAG prompt configuration

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time> | null

Last update timestamp