Skip to content

Console SDK

Cognipeer Console SDK ​

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

  • Package @cognipeer/console-sdk
  • Language TypeScript, no any escape hatches
  • API OpenAI-compatible where it matters

The SDK is the application-layer client; Console is the platform underneath it. Reach for the SDK when you're wiring Cognipeer into a Node, Next.js, or browser app and want resource methods instead of raw HTTP. Go to the Console docs when you're provisioning tenants, providers, or deployment targets instead.

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 ?? '');
}

Every Console resource, one client ​

ResourceWhat it gives youReference
Chat completionsOpenAI-compatible chat with first-class streaming — drop it in where you already call OpenAI.Chat
Agents APIMulti-turn Responses with tool bindings, version pinning, and structured outputs.Agents
Agent sessionsStart a session before the first message, upload files, cap spend, read runtime state, and list or delete conversations.Sessions
Approvals & eventsAnswer tool approvals and questions, page or follow a session's event log with a self-reconnecting stream.Approvals & questions
WebhooksSigned event deliveries for session, approval, budget and run events, with verifyWebhook for your server.Webhooks
Tools (deprecated)The tools endpoints are retired; bind tools to agents or use MCP.Tools
Browser automationCreate browser profiles, drive live sessions, call a browser published as an MCP server.Browser
Embeddings & vectorsOne API across Chroma, Postgres, Elasticsearch, Azure AI Search, and S3 Vectors.Vectors
Files & memoryUpload documents with markdown conversion, thread them into long-lived memory.Files
Config & guardrailsManage secrets and group resolution, apply guardrails per environment.Guardrails
TracingEvery agent run produces a structured trace — spans, tool calls, latencies.Tracing
Realtime & voiceWebSocket sessions with streaming responses and an optional STT/TTS round-trip.Realtime
Agent SandboxRemote runtime containers — exec, run code, manage files and git, snapshot or fork.Sandbox
Batch, moderations & spendAsync batch inference, guardrail-backed moderation, spend reports with budget caps.Batches
Strict typesFull TypeScript, no any escape hatches — generics carry through streams and tools.Type safety

Where to go next ​

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

Studio · Pulse · Console · Agent SDK and more — the Cognipeer documentation hub