NewWacht Bench is live — AI-assisted development for Wacht

listKnowledgeBaseDocuments()

This method lists documents indexed in a knowledge base.

Usage

The following example shows a basic usage of the backend client from @wacht/nextjs/server.

import { wachtClient } from '@wacht/nextjs/server';export async function example() {  const client = await wachtClient();  const kbId: string = 'kbid-123';  const options: { limit?: number; offset?: number } = {    limit: 20,    offset: 0,  };  return client.ai.listKnowledgeBaseDocuments(kbId, options);}

Signature

function listKnowledgeBaseDocuments(  kbId: string,  options?: { limit?: number; offset?: number },  client?: WachtClient,): Promise<PaginatedResponse<AiKnowledgeBaseDocument>>

Parameters

kbId: string;
Target knowledge base id.
options?: { limit?: number; offset?: number } | undefined;
Optional query/filter object used to shape list/search behavior.
limit?: number | undefined;
limit value used by this request.
offset?: number | undefined;
offset value used by this request.

Return value

data?: AiKnowledgeBaseDocument[] | undefined;
Current page result items.
has_more?: boolean | undefined;
Whether additional pages are available.
limit?: number | undefined;
Effective page size when returned by backend.
offset?: number | undefined;
Effective offset when returned by backend.

Examples

AI usage pattern

import { wachtClient } from '@wacht/nextjs/server';export async function createKbAndUpload(file: File) {  const client = await wachtClient();  const kb = await client.ai.createKnowledgeBase({    name: 'Support Docs',    description: 'Knowledge base for support runbooks',  });  const doc = await client.ai.uploadKnowledgeBaseDocument(kb.id, file, 'runbook.md', 'Support runbook');  return { kb, doc };}

On this page