curl --request POST \
--url https://api.cloudtalk.io/v1/knowledge-bases \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "returns-policy",
"sourceType": "URL",
"text": "We accept returns within 30 days.",
"url": "https://example.com/returns"
}
'import requests
url = "https://api.cloudtalk.io/v1/knowledge-bases"
payload = {
"name": "returns-policy",
"sourceType": "URL",
"text": "We accept returns within 30 days.",
"url": "https://example.com/returns"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'returns-policy',
sourceType: 'URL',
text: 'We accept returns within 30 days.',
url: 'https://example.com/returns'
})
};
fetch('https://api.cloudtalk.io/v1/knowledge-bases', 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.cloudtalk.io/v1/knowledge-bases",
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([
'name' => 'returns-policy',
'sourceType' => 'URL',
'text' => 'We accept returns within 30 days.',
'url' => 'https://example.com/returns'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.cloudtalk.io/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/knowledge-bases")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"attributes": {
"createdAt": "2023-11-07T05:31:56Z",
"fileExtension": "<string>",
"name": "<string>",
"sourceType": "URL",
"sourceUrl": "<string>",
"status": "ACTIVE",
"updatedAt": "2023-11-07T05:31:56Z",
"voiceAgentIds": [
"<string>"
]
},
"id": "<string>",
"type": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}Create a knowledge base
Creates a knowledge base from an address or from inline text. A URL source starts SYNCHRONIZING and turns ACTIVE once it has been read. A company may hold at most 100 knowledge bases; at the cap the request answers 409 KNOWLEDGE_BASE_LIMIT_REACHED.
curl --request POST \
--url https://api.cloudtalk.io/v1/knowledge-bases \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "returns-policy",
"sourceType": "URL",
"text": "We accept returns within 30 days.",
"url": "https://example.com/returns"
}
'import requests
url = "https://api.cloudtalk.io/v1/knowledge-bases"
payload = {
"name": "returns-policy",
"sourceType": "URL",
"text": "We accept returns within 30 days.",
"url": "https://example.com/returns"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'returns-policy',
sourceType: 'URL',
text: 'We accept returns within 30 days.',
url: 'https://example.com/returns'
})
};
fetch('https://api.cloudtalk.io/v1/knowledge-bases', 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.cloudtalk.io/v1/knowledge-bases",
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([
'name' => 'returns-policy',
'sourceType' => 'URL',
'text' => 'We accept returns within 30 days.',
'url' => 'https://example.com/returns'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.cloudtalk.io/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/knowledge-bases")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"returns-policy\",\n \"sourceType\": \"URL\",\n \"text\": \"We accept returns within 30 days.\",\n \"url\": \"https://example.com/returns\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"attributes": {
"createdAt": "2023-11-07T05:31:56Z",
"fileExtension": "<string>",
"name": "<string>",
"sourceType": "URL",
"sourceUrl": "<string>",
"status": "ACTIVE",
"updatedAt": "2023-11-07T05:31:56Z",
"voiceAgentIds": [
"<string>"
]
},
"id": "<string>",
"type": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}Authorizations
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Body
Name of the knowledge base
1 - 50"returns-policy"
Where the content comes from; upload a file through POST /knowledge-bases/files
URL, CUSTOM "URL"
Content of the knowledge base; required when sourceType is CUSTOM, rejected otherwise
"We accept returns within 30 days."
Address to read the content from; required when sourceType is URL, rejected otherwise
"https://example.com/returns"