Chat with knowledge base using conversational context
curl --request POST \
--url https://api.cleartalk.ai/knowledge-base/chat \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messages": [
{
"role": "user",
"content": "What is your refund policy?"
}
],
"knowledge_base_id": "kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V",
"type": "web"
}
'import requests
url = "https://api.cleartalk.ai/knowledge-base/chat"
payload = {
"messages": [
{
"role": "user",
"content": "What is your refund policy?"
}
],
"knowledge_base_id": "kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V",
"type": "web"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{role: 'user', content: 'What is your refund policy?'}],
knowledge_base_id: 'kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V',
type: 'web'
})
};
fetch('https://api.cleartalk.ai/knowledge-base/chat', 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.cleartalk.ai/knowledge-base/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
'role' => 'user',
'content' => 'What is your refund policy?'
]
],
'knowledge_base_id' => 'kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V',
'type' => 'web'
]),
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.cleartalk.ai/knowledge-base/chat"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.cleartalk.ai/knowledge-base/chat")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/knowledge-base/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}"
response = http.request(request)
puts response.read_bodyKnowledge Base
Chat with knowledge base using conversational context
POST
/
knowledge-base
/
chat
Chat with knowledge base using conversational context
curl --request POST \
--url https://api.cleartalk.ai/knowledge-base/chat \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messages": [
{
"role": "user",
"content": "What is your refund policy?"
}
],
"knowledge_base_id": "kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V",
"type": "web"
}
'import requests
url = "https://api.cleartalk.ai/knowledge-base/chat"
payload = {
"messages": [
{
"role": "user",
"content": "What is your refund policy?"
}
],
"knowledge_base_id": "kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V",
"type": "web"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{role: 'user', content: 'What is your refund policy?'}],
knowledge_base_id: 'kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V',
type: 'web'
})
};
fetch('https://api.cleartalk.ai/knowledge-base/chat', 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.cleartalk.ai/knowledge-base/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
'role' => 'user',
'content' => 'What is your refund policy?'
]
],
'knowledge_base_id' => 'kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V',
'type' => 'web'
]),
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.cleartalk.ai/knowledge-base/chat"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.cleartalk.ai/knowledge-base/chat")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/knowledge-base/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is your refund policy?\"\n }\n ],\n \"knowledge_base_id\": \"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V\",\n \"type\": \"web\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key for authentication
Body
application/json
Array of chat messages for conversational context
Show child attributes
Show child attributes
Example:
[
{
"role": "user",
"content": "What is your refund policy?"
}
]
The ID of the knowledge base to query against
Example:
"kb_01H8X9QK5R2N7P3M6Z8N4Y1V7V"
Type of query
Example:
"web"
Response
Chat response generated successfully
Discover sitemap URLs from a website for web scrapingGet paginated list of knowledge bases from cleartalk AI
⌘I
