VoxLink.ai

API Reference

Get documents

Get all documents in a knowledgebase

Updated 25 Jan 2026

This endpoint returns a list of all documents in a specific knowledgebase.

Path Parameters

knowledgebaseIdintegerrequired

The unique identifier of the knowledgebase

Response

dataarray

Array of document objects

idinteger

  The unique identifier of the document

namestring

  The name of the document

descriptionstring

  Optional description of the document

typestring

  Document type: `website`, `pdf`, `txt`, or `docx`

type_labelstring

  Human-readable type label

statusstring

  Processing status: `processing`, `active`, or `failed`

status_labelstring

  Human-readable status label

created_atstring

  ISO 8601 timestamp of creation

updated_atstring

  ISO 8601 timestamp of last update
{
  "data": [
    {
      "id": 1,
      "name": "Product Manual",
      "description": "Complete product user manual",
      "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"
    }
  ]
}
{
  "error": "Knowledgebase not found."
}

Document Statuses

Status Description
processing Document is being parsed and embedded into the vector database
active Document has been processed and is ready for use
failed Document processing failed

Related guides