Skip to main content
GET
/
v1
/
knowledge
List Knowledge Bases
curl --request GET \
  --url https://api.xpander.ai/v1/knowledge \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.xpander.ai/v1/knowledge"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/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.xpander.ai/v1/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 => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.xpander.ai/v1/knowledge"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	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.xpander.ai/v1/knowledge")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/knowledge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "description": "<string>",
      "agent_id": "<string>",
      "total_documents": 0
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
Retrieve all knowledge bases in your organization with document counts and metadata.

​
Query Parameters

​
page
integer
default:1
Page number (starting from 1)
​
per_page
integer
default:20
Items per page (maximum 50)

​
Response

​
items
array
Array of knowledge base objects
​
total
integer
Total number of knowledge bases
​
page
integer
Current page number
​
per_page
integer
Number of items per page
​
total_pages
integer
Total number of pages available

​
Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/knowledge?page=1&per_page=2"

​
Example Response

{
  "items": [
    {
      "id": "73dc30ca-bdbf-42f7-a39f-93aff4f8522e",
      "name": "Product Catalog",
      "description": "Complete product information and specifications",
      "type": "managed",
      "organization_id": "<org-id>",
      "agent_id": null,
      "total_documents": 12
    },
    {
      "id": "e21563bd-7c02-4f8f-9520-8c854f5c2ee6",
      "name": "Company Policies",
      "description": "Internal policies and procedures documentation",
      "type": "managed",
      "organization_id": "<org-id>",
      "agent_id": null,
      "total_documents": 8
    }
  ],
  "total": 5,
  "page": 1,
  "per_page": 2,
  "total_pages": 3
}

​
Notes

  • Knowledge bases are automatically filtered by your organization
  • total_documents reflects the number of documents currently indexed
  • Use pagination to retrieve large lists of knowledge bases

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
page
integer
default:1

Page number (starting from 1)

Required range: x >= 1
​
per_page
integer
default:20

Items per page (max 50)

Required range: 1 <= x <= 50

Response

Successful Response

​
items
KnowledgeBaseItem · object[]
required
​
total
integer
required
​
page
integer
required
​
per_page
integer
required
​
total_pages
integer
required