Skip to main content
GET
/
v1
/
knowledge
/
{kb_id}
/
documents
Get Knowledge Base Documents
curl --request GET \
  --url https://api.xpander.ai/v1/knowledge/{kb_id}/documents \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "document_url": "<string>",
      "kb_id": "<string>",
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}
Retrieve all documents stored in a specific knowledge base with pagination support. This endpoint returns document metadata including IDs and URLs.

​
Path Parameters

​
kb_id
string
required
Unique identifier of the knowledge base (UUID format)

​
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 document objects
​
total
integer
Total number of documents in the knowledge base
​
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/<kb-id>/documents?page=1&per_page=10"

​
Example Response

{
  "items": [
    {
      "kb_id": "<kb-id>",
      "id": "<document-id>",
      "name": "https://docs.example.com/quickstart",
      "document_url": "https://docs.example.com/quickstart"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 10,
  "total_pages": 1
}

​
Notes

  • Documents are returned in the order they were added to the knowledge base
  • The document_url field contains the full URL to access the document file
  • Use this endpoint to audit what documents are in a knowledge base
  • Combine with Get Document to retrieve full document details

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
kb_id
string
required

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
KnowledgeBaseDocumentItem · object[]
required
​
total
integer
required
​
page
integer
required
​
per_page
integer
required
​
total_pages
integer
required