Skip to content

Console SDKTypeScript for the Cognipeer Console.

One client, every Console resource — chat, agents, browsers, vectors, files, tracing. Calm types, streaming-first, OpenAI-compatible where it matters.

Cognipeer Console SDK

Where this fits

SDK or Console — pick the surface that matches the work.

The SDK is the application-layer client. The Console is the platform. Most teams need both, but for different reasons.

Reach for the SDK when you are

  • Wiring Cognipeer into a Node, Next.js, or browser app
  • Writing TypeScript and want resource methods, not raw HTTP
  • Streaming chat, tracing agents, or driving browser sessions from code

Go to Console docs when you are

  • Provisioning tenants, providers, or deployment targets
  • Reviewing raw API contracts or platform-level semantics
  • Operating the platform rather than calling it

Install

One package. Every resource on the client.

bash
npm install @cognipeer/console-sdk
bash
pnpm add @cognipeer/console-sdk
bash
yarn add @cognipeer/console-sdk

First call

A streaming chat completion in twelve lines.

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

const client = new ConsoleClient({ apiKey: process.env.COGNIPEER_API_KEY! });

const stream = await client.chat.completions.create({
  model: 'gpt-4o',
  stream: true,
  messages: [
    { role: 'system', content: 'You are a precise assistant.' },
    { role: 'user',   content: 'Summarize the Q3 release notes.' },
  ],
});

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

Entry points

Where to start, by what you're trying to do.

You are…Open thisWhat you get
Deciding how Console and the SDK divide responsibilityWorking with ConsoleA clear split between platform ops and app integration
Wiring the client into a new serviceGetting startedInstall, auth, base URL, the first request
Mapping existing HTTP calls to SDK methodsConsole API mappingOne-to-one method-to-endpoint reference
Following an end-to-end exampleExamplesChat, streaming, RAG, memory, tracing — runnable

Help

Stuck somewhere?

Open a GitHub issue — the team triages from there. For platform questions (provider keys, tenants, billing) head to the Console docs instead.

Released under the MIT License.