List knowledge base documents
curl --request GET \
--url https://api.instaview.sk/agents/{id}/knowledge \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instaview.sk/agents/{id}/knowledge"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instaview.sk/agents/{id}/knowledge', 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.instaview.sk/agents/{id}/knowledge",
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.instaview.sk/agents/{id}/knowledge"
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.instaview.sk/agents/{id}/knowledge")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instaview.sk/agents/{id}/knowledge")
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{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "Benefits and perks",
"status": "READY",
"isActive": true,
"source": "UPLOAD",
"createdAt": "2026-08-08T10:15:00.000Z",
"fileName": "benefits-and-perks.pdf",
"mimeType": "application/pdf",
"sizeBytes": 482133
}
],
"total": 3,
"limit": 10
}Agent Knowledge Base
List Knowledge Documents
Lists every document attached to the agent’s knowledge base, including ones whose upload has not been completed yet (status: PENDING).
GET
/
agents
/
{id}
/
knowledge
List knowledge base documents
curl --request GET \
--url https://api.instaview.sk/agents/{id}/knowledge \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instaview.sk/agents/{id}/knowledge"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instaview.sk/agents/{id}/knowledge', 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.instaview.sk/agents/{id}/knowledge",
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.instaview.sk/agents/{id}/knowledge"
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.instaview.sk/agents/{id}/knowledge")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instaview.sk/agents/{id}/knowledge")
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{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "Benefits and perks",
"status": "READY",
"isActive": true,
"source": "UPLOAD",
"createdAt": "2026-08-08T10:15:00.000Z",
"fileName": "benefits-and-perks.pdf",
"mimeType": "application/pdf",
"sizeBytes": 482133
}
],
"total": 3,
"limit": 10
}Lists every document attached to an agent’s knowledge base.
Overview
Returns documents oldest first, including ones whose upload has not been completed yet. The response is not paginated — an agent holds at most 10 documents.Reading the Response
| Field | Meaning |
|---|---|
status | PENDING while waiting for the file and its completion call; READY once verified |
isActive | Whether the agent may consult the document on a call. Always false while PENDING |
sizeBytes | Size as verified against storage. Absent until the document is READY |
total | Documents currently attached, including pending ones |
limit | Maximum documents one agent may hold |
A
PENDING document still counts against limit. If total has reached
limit and some documents are pending, either complete or delete them to free
a slot — abandoned uploads are reclaimed automatically after 24 hours.Example
curl https://api.instaview.sk/agents/$AGENT_ID/knowledge \
-H "Authorization: Bearer $INSTAVIEW_API_KEY"
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "Benefits and perks",
"fileName": "benefits-and-perks.pdf",
"mimeType": "application/pdf",
"sizeBytes": 482133,
"status": "READY",
"isActive": true,
"createdAt": "2026-08-08T10:15:00.000Z"
}
],
"total": 1,
"limit": 10
}
Related Resources
Authorizations
API key for authentication using Bearer scheme
Path Parameters
Agent the knowledge base belongs to.
Query Parameters
Required for ATS API keys to specify which company to access. Ignored for standard company API keys.
Response
Documents attached to the agent, oldest first
Documents attached to the agent or contact, oldest first
Show child attributes
Show child attributes
Number of documents attached
Example:
3
Maximum uploaded documents the resource may hold: 10 for an agent, 5 for a contact. A contact's CV document does not count towards it.
Example:
10