Skip to main content

TypeScript / JavaScript SDK

The official TypeScript and Node.js client library for the Knowledgator API platform. Fully typed with async/await support across all operations.


Installation​

Install via npm, yarn, or pnpm (Node.js 18+ supported):

npm install @knowledgator/typescript-sdk

Or with yarn:

yarn add @knowledgator/typescript-sdk

Or with pnpm:

pnpm add @knowledgator/typescript-sdk

Quickstart & Authentication​

Obtain your API key from api.platform.knowledgator.com or authenticate using your preferred method:

When KG_API_KEY, KG_MCP_API_KEY, or KNOWLEDGATOR_API_KEY is set in your environment, initialize with zero arguments:

import { createClient } from '@knowledgator/typescript-sdk';

// Automatically resolves from environment variables
const client = createClient();

2. Explicit API Key​

import { createClient } from '@knowledgator/typescript-sdk';

const client = createClient('your-api-key-here');

3. Bearer Token / JWT Authentication​

import { createClient } from '@knowledgator/typescript-sdk';

// Passing a JWT or Bearer string automatically sets Authorization: Bearer <token>
const client = createClient('Bearer eyJhbGciOi...');

Example: Zero-Shot Classification​

// Zero-shot classification example
const response = await client.comprehend.it({
text: 'Earth is beautiful and rich with life',
labels: ['science', 'geography', 'sports'],
threshold: 0.5,
});

console.log(response);

SDK Modules​

The TypeScript SDK mirrors the Knowledgator platform services:

  • Comprehend-it (client.comprehend.it)
  • Extract-it (client.extract.it, client.extract.relations, client.extract.summary)
  • Instruct-it (client.instruct.it)
  • Datasets (client.datasets.list, client.datasets.create, client.datasets.generatePlan, client.datasets.generate)
  • Fine-tuning (client.finetuning.startTraining, client.finetuning.getTraining)
  • Open Models (client.model("model-id").predict)
  • Raw Data (client.datasets.listData, client.datasets.createData)