v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB
Knowledge Bases

List Documents

List documents in a knowledge base with pagination, filtering, and sorting.

get/api/v1/knowledge/{id}/documents

Path parameters

idstring required

Knowledge base ID.

Query parameters

workspaceIdstring required

The unique identifier of the workspace.

limitinteger

Maximum number of documents to return (1-100, default 50).

offsetinteger

Number of documents to skip (default 0).

searchstring

Search documents by filename.

enabledFilter'all' | 'enabled' | 'disabled'

Filter by enabled status.

sortBy'filename' | 'fileSize' | 'tokenCount' | 'chunkCount' | 'uploadedAt' | 'processingStatus' | 'enabled'

Field to sort by.

sortOrder'asc' | 'desc'

Sort direction.

Response

List of documents.

successboolean

Whether the request was successful.