Skip to main content
GET
/
api
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
List Documents
curl --request GET \
  --url https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "name": "Product Handbook",
      "description": "Complete user manual for the product",
      "type": "pdf",
      "type_label": "PDF",
      "status": "active",
      "status_label": "Active",
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-05T10:35:00.000000Z"
    },
    {
      "id": 2,
      "name": "Company Website",
      "description": "Main website content",
      "type": "website",
      "type_label": "Website",
      "status": "processing",
      "status_label": "Processing",
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:00:00.000000Z"
    }
  ]
}
This endpoint returns a list of all documents in a specific knowledge base.

​
Path Parameters

​
knowledgebaseId
integer
required
The unique identifier of the knowledge base

​
Response Fields

​
data
array
Array of document objects

​
Document Status

StatusDescription
processingDocument is being analyzed and embedded into the vector database
activeDocument has been processed and is ready to use
failedDocument processing failed
{
  "data": [
    {
      "id": 1,
      "name": "Product Handbook",
      "description": "Complete user manual for the product",
      "type": "pdf",
      "type_label": "PDF",
      "status": "active",
      "status_label": "Active",
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-05T10:35:00.000000Z"
    },
    {
      "id": 2,
      "name": "Company Website",
      "description": "Main website content",
      "type": "website",
      "type_label": "Website",
      "status": "processing",
      "status_label": "Processing",
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:00:00.000000Z"
    }
  ]
}
Related pages: Introduction and Authentication Guide, and API Integration Examples.