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": "<string>",
"datasetIds": [
"<string>"
],
"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>"
}
}
'import requests
url = "https://api.starleads.co/KnowledgeBaseChat/{chatId}"
payload = {
"name": "<string>",
"datasetIds": ["<string>"],
"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>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
datasetIds: ['<string>'],
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>'
}
})
};
fetch('https://api.starleads.co/KnowledgeBaseChat/{chatId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.starleads.co/KnowledgeBaseChat/{chatId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'datasetIds' => [
'<string>'
],
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.starleads.co/KnowledgeBaseChat/{chatId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.starleads.co/KnowledgeBaseChat/{chatId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.starleads.co/KnowledgeBaseChat/{chatId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Knowledge Base — Chats
Update a knowledge base chat
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": "<string>",
"datasetIds": [
"<string>"
],
"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>"
}
}
'import requests
url = "https://api.starleads.co/KnowledgeBaseChat/{chatId}"
payload = {
"name": "<string>",
"datasetIds": ["<string>"],
"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>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
datasetIds: ['<string>'],
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>'
}
})
};
fetch('https://api.starleads.co/KnowledgeBaseChat/{chatId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.starleads.co/KnowledgeBaseChat/{chatId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'datasetIds' => [
'<string>'
],
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.starleads.co/KnowledgeBaseChat/{chatId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.starleads.co/KnowledgeBaseChat/{chatId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.starleads.co/KnowledgeBaseChat/{chatId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"datasetIds\": [\n \"<string>\"\n ],\n \"llmSettings\": {\n \"temperature\": 123,\n \"topP\": 123,\n \"presencePenalty\": 123,\n \"frequencyPenalty\": 123\n },\n \"promptSettings\": {\n \"similarityThreshold\": 123,\n \"keywordsSimilarityWeight\": 123,\n \"topN\": 123,\n \"prompt\": \"<string>\",\n \"opener\": \"<string>\",\n \"emptyResponse\": \"<string>\",\n \"showQuote\": true,\n \"rerankModel\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Headers
API key for authentication
Path Parameters
Body
application/jsontext/jsonapplication/*+json
Partial update for a chat. Only provided fields will be updated
Response
Success
Public representation of a knowledge base chat
Chat identifier
Chat name
Connected dataset IDs
Connected dataset names (read-only)
Number of agents using this chat
LLM configuration parameters exposed to the API (excludes model name)
Show child attributes
Show child attributes
RAG prompt configuration
Show child attributes
Show child attributes
Creation timestamp
Last update timestamp

