Skip to main content

listInstances

client.knowledgeGraph.listInstances(params?: Record<string, unknown>): Promise<KGInstance[]>

Lists all knowledge graph instances.

Returns every graph instance in the system with their metadata and record/edge counts.

Parameters

ParameterTypeRequiredDescription
paramsRecord<string, unknown>NoOptional query parameters for filtering or pagination

Returns

Promise<KGInstance[]> — A promise that resolves to an array of objects

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.knowledgeGraph.listInstances();
console.log(result);