Skip to content

Cognipeer Console SDKCognipeer Console SDK

Official TypeScript/JavaScript SDK for integrating with Cognipeer Console

Cognipeer Console SDK

Quick Start

Where This Fits

Use the SDK when you are writing application code that talks to an existing Cognipeer Console deployment.

  • Need deployment, tenant model, providers, or raw API semantics? Go to the Cognipeer Console docs.
  • Need TypeScript or JavaScript examples, client configuration, and resource methods? Stay in the SDK docs.

Choose Your Entry Point

Start withBest forWhat you get
Working with ConsoleTeams deciding how Console and the SDK fit togetherClear responsibility split between platform operations and app integration
Getting StartedDevelopers wiring the SDK into an appInstall, auth, base URL, first request
Console API MappingTeams migrating from raw HTTP calls or reviewing API ownershipDirect mapping between SDK methods and Console endpoints
bash
npm install @cognipeer/console-sdk
bash
yarn add @cognipeer/console-sdk
bash
pnpm add @cognipeer/console-sdk

Basic Usage

typescript
import { ConsoleClient } from '@cognipeer/console-sdk';

const client = new ConsoleClient({
  apiKey: 'your-api-key',
});

// Chat completion
const response = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [
    { role: 'system', content: 'You are a helpful assistant.' },
    { role: 'user', content: 'Hello!' },
  ],
});

console.log(response.choices[0].message.content);

// Streaming
const stream = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [{ role: 'user', content: 'Tell me a story' }],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content || '');
}

Why Cognipeer Console SDK?

  • OpenAI Compatible: Drop-in replacement for OpenAI SDK with extended features
  • Multi-Provider: Support for multiple LLM and vector database providers
  • Enterprise Ready: Built for multi-tenant SaaS with complete data isolation
  • Production Tested: Used in production by Cognipeer customers
  • Active Development: Regular updates and new features

Learn More

📖 Documentation

Check out the Getting Started Guide to learn more.

💡 Examples

Explore our Examples for common use cases and patterns.

🆘 Support

Need help? Open an issue on GitHub.

Released under the MIT License.