List Knowledge Bases
curl --request GET \
--url https://app.famulor.de/api/user/knowledgebasesimport requests
url = "https://app.famulor.de/api/user/knowledgebases"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.famulor.de/api/user/knowledgebases', 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://app.famulor.de/api/user/knowledgebases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://app.famulor.de/api/user/knowledgebases"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.de/api/user/knowledgebases")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.de/api/user/knowledgebases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"name": "Product Documentation",
"description": "Technical documentation for our products",
"status": "active",
"status_label": "Active",
"documents_count": 5,
"assistants_count": 2,
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-08T14:20:00.000000Z"
},
{
"id": 2,
"name": "FAQ Knowledge",
"description": "Frequently asked questions and answers",
"status": "processing",
"status_label": "Processing",
"documents_count": 1,
"assistants_count": 0,
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:05:00.000000Z"
}
]
}
{
"data": []
}
Knowledgebases
List Knowledge Bases
Retrieves all knowledge bases of the authenticated user
GET
/
api
/
user
/
knowledgebases
List Knowledge Bases
curl --request GET \
--url https://app.famulor.de/api/user/knowledgebasesimport requests
url = "https://app.famulor.de/api/user/knowledgebases"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.famulor.de/api/user/knowledgebases', 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://app.famulor.de/api/user/knowledgebases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://app.famulor.de/api/user/knowledgebases"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.de/api/user/knowledgebases")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.de/api/user/knowledgebases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"name": "Product Documentation",
"description": "Technical documentation for our products",
"status": "active",
"status_label": "Active",
"documents_count": 5,
"assistants_count": 2,
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-08T14:20:00.000000Z"
},
{
"id": 2,
"name": "FAQ Knowledge",
"description": "Frequently asked questions and answers",
"status": "processing",
"status_label": "Processing",
"documents_count": 1,
"assistants_count": 0,
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:05:00.000000Z"
}
]
}
{
"data": []
}
Famulor 1.0 API (legacy). This page applies only to Famulor 1.0 (
app.famulor.de) and is retained for legacy compatibility. For the current platform, use the Famulor 2.0 API reference.Response Fields
array
Array of knowledge base objects
Show Knowledge Base Properties
Show Knowledge Base Properties
integer
The unique identifier of the knowledge base
string
The name of the knowledge base
string
Optional description of the knowledge base
string
Current status:
empty, processing, active or failedstring
Human-readable status label
integer
Number of documents in this knowledge base
integer
Number of assistants using this knowledge base
string
ISO 8601 timestamp of creation
string
ISO 8601 timestamp of last update
Knowledge Base Status
| Status | Description |
|---|---|
empty | Knowledge base has no documents |
processing | One or more documents are being processed |
active | All documents are processed and ready |
failed | One or more documents failed to process |
{
"data": [
{
"id": 1,
"name": "Product Documentation",
"description": "Technical documentation for our products",
"status": "active",
"status_label": "Active",
"documents_count": 5,
"assistants_count": 2,
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-08T14:20:00.000000Z"
},
{
"id": 2,
"name": "FAQ Knowledge",
"description": "Frequently asked questions and answers",
"status": "processing",
"status_label": "Processing",
"documents_count": 1,
"assistants_count": 0,
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:05:00.000000Z"
}
]
}
{
"data": []
}
Related pages: Introduction and Authentication Guide, and API Integration Examples.
⌘I