Get Knowledge Base
curl --request GET \
--url https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}', 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-prod.interactly.ai/kb/v1/knowledge-bases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "5f7b1b1b1b1b1b1b1b1b1b1b",
"status": "trained",
"description": "Knowledge Base Description",
"title": "Knowledge Base Title",
"retrain_frequency_minutes": 1440,
"docs": [
{
"type": "url",
"payload": {
"urls_to_include": [
{
"url": "<string>",
"subpaths_only": false,
"recursive": false
}
],
"urls_to_exclude": [
{
"url": "<string>",
"subpaths_only": false,
"recursive": false
}
]
}
}
],
"files": [
{
"id": "5f7b1b1b1b1b1b1b1b1b1b1b",
"name": "some_file.json",
"type": "file",
"createdAt": "2020-10-05T00:00:00.000Z",
"updatedAt": "2020-10-05T00:00:00.000Z"
}
]
}{
"detail": "Knowledge base not found"
}Knowledge Bases
Get Knowledge Base
Get Knowledge Base
GET
/
kb
/
v1
/
knowledge-bases
/
{id}
Get Knowledge Base
curl --request GET \
--url https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}', 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-prod.interactly.ai/kb/v1/knowledge-bases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "5f7b1b1b1b1b1b1b1b1b1b1b",
"status": "trained",
"description": "Knowledge Base Description",
"title": "Knowledge Base Title",
"retrain_frequency_minutes": 1440,
"docs": [
{
"type": "url",
"payload": {
"urls_to_include": [
{
"url": "<string>",
"subpaths_only": false,
"recursive": false
}
],
"urls_to_exclude": [
{
"url": "<string>",
"subpaths_only": false,
"recursive": false
}
]
}
}
],
"files": [
{
"id": "5f7b1b1b1b1b1b1b1b1b1b1b",
"name": "some_file.json",
"type": "file",
"createdAt": "2020-10-05T00:00:00.000Z",
"updatedAt": "2020-10-05T00:00:00.000Z"
}
]
}{
"detail": "Knowledge base not found"
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Path Parameters
Knowledge Base ID
Response
Successful response
Example:
"5f7b1b1b1b1b1b1b1b1b1b1b"
Available options:
draft, created, queued, training, trained Example:
"trained"
Example:
"Knowledge Base Description"
A descriptive and human-readable name for the knowledge base
Example:
"Knowledge Base Title"
Automatic retrain interval in minutes
Example:
1440
Here you can upload URLs
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I