getDocumentFiles()

getDocumentFiles(options?: { limit?: number; offset?: number; }): Promise<DocumentFilesResponse>

Defined in: packages/core/src/document-search/index.ts:533

Get indexed document files (optimized for fast loading)

Retrieves minimal file info (file_hash, source, source_filename) for indexed documents with pagination support.

Parameters

Parameter	Type	Description
options?	{ limit?: number; offset?: number; }	Optional pagination parameters
options.limit?	number	(optional, default: 100, max: 1000) Maximum files to return
options.offset?	number	(optional, default: 0) Pagination offset

Returns

Promise<DocumentFilesResponse>

Promise resolving to DocumentFilesResponse:

• files - Array of DocumentFileMinimal objects
• total - Total number of indexed files (for pagination UI)
• limit - Requested limit
• offset - Requested offset

Each file contains:

• file_hash - Unique file identifier
• source - Source name the file belongs to
• source_filename - Original filename with path

Throws

401 - Not authenticated

Example

import { getDocumentFiles, searchDocuments } from "@cpod/sdk";

// Get first 100 files (default)
const { files, total } = await getDocumentFiles();
console.log(`Found ${total} indexed files, showing ${files.length}`);

// Paginated access
const page1 = await getDocumentFiles({ limit: 10, offset: 0 });
const page2 = await getDocumentFiles({ limit: 10, offset: 10 });

// Search within specific files
const results = await searchDocuments({
  query: "compliance",
  fileHashes: files.map(f => f.file_hash),
});