Appearance

Release notes · Console SDK

Console SDK Release Notes ​

Changelog for @cognipeer/console-sdk. For usage, see the Console SDK documentation.

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.7.0] - 2026-08-17 ​

Added ​

  • New resources: client.analytics (usage/overview), client.audit (logs), client.monitoring (inference), client.pii (policy CRUD + detect/redact/…) — additive, no existing method/resource/type changed.
  • client.tracing.listThreads / getThread.
  • Authoring on existing resources — agents/tools/mcp/prompts/guardrails/rag/reranker gained create/update/delete (plus publish/sync/setLatestVersion/refreshTools where applicable).
  • metadata on tracing sessions — client.tracing.ingest/startStream accept an optional metadata: Record<string, string> sibling of agent, for grouping/reporting spend by arbitrary attribution tags.

Changed ​

  • Default baseURL is now https://console.cognipeer.com (was https://api.cognipeer.com). Only affects clients constructed without an explicit baseURL.

Fixed ​

  • client.tools.* routing — list, get, execute and the deprecated agent-tool helpers were missing the /api/client/v1 prefix, so every Tools call hit the wrong URL.

[1.6.0] - 2026-07-17 ​

Added ​

  • MCP Hubs discovery client (client.mcp.hubs.list/get/servers/server) — hub catalog discovery via the MCP Registry envelope, with cursor pagination and tool schemas on the detail view.
  • client.realtime.connect({ runtimeContext }) — sends session-scoped downstream auth right after the socket opens, refreshable via updateSession.

[1.5.0] - 2026-07-14 ​

Added ​

  • Aegis API (client.aegis, Enterprise) — enforcement-plane policy evaluation: evaluate() returns an allow/redact/require_approval/sandbox/block decision with findings, risk score and a sanitized resource; shields.list() and shields.audit(shieldId) read the enforcement instances and their decision trails. Shields are configured in the Console dashboard (/dashboard/aegis).

[1.4.1] - 2026-07-07 ​

Added ​

  • client.sandbox.listeningPorts(id) — TCP ports currently LISTENing inside a sandbox, with a loopbackOnly flag (a service bound only to 127.0.0.1 must be restarted on 0.0.0.0 to be previewable).
  • SandboxPreviewInfo.allPorts — when true (platform default), any port is previewable through previewUrl(id, port) / share links, not just the suggested list; the platform provisions an on-demand forwarder for unpublished ports.

[1.4.0] - 2026-07-05 ​

Added ​

  • Web Search API (client.webSearch) — run searches through Console-configured Web Search instances (Bing, Brave Search, Serper, Tavily, SearxNG, DuckDuckGo): search(...), searchWith(key, ...) for a named instance, include_answer: true for AI-interpreted answers, providers.list().
  • Crawler sync runs — client.crawler.run(...) / crawlWithCrawler(...) accept mode: 'sync' and resolve with the finished job plus inline results (CrawlRunSyncResponse, markdown included); new single-URL convenience client.crawler.crawlUrl(idOrKey, url).

Fixed ​

  • client.crawler.runAdhoc(...) now sends seeds (the field the server's ad-hoc schema requires) instead of urls, and exposes engine/maxDepth/maxPages/mode options.

[1.3.4] - 2026-07-02 ​

Removed ​

  • Breaking: JS Sandbox API (client.jsSandbox) and its types (JsSandboxRuntime, JsSandboxExecuteRequest, JsSandboxExecutionResult, …) — the JS Sandbox module was removed from the Console platform. Use the Agent Sandbox (client.sandbox) code/exec APIs for code execution instead. Note: this removal shipped as a patch release, not a major bump — pin an exact version if you still depend on client.jsSandbox.

[1.3.3] - 2026-06-29 ​

Added ​

  • client.sandbox.setPreview(id, { enabled?, public? }) — toggle port preview on/off and public (share links) vs. private (login-only), applied live; create() accepts previewEnabled/previewPublic; preview()/SandboxPreviewInfo now expose enabled/public.

[1.3.2] - 2026-06-27 ​

Added ​

  • Sandbox port preview helpers — sandbox.preview(id) (list previewable ports and their proxy URLs), sandbox.createPreviewLink(id, port, opts?) (session-less, expiring share link), sandbox.previewUrl(id, port, path?) (authenticated proxy path).
  • resources override (cpuCores/memoryMb/diskMb/pids) on sandbox.create() and on snapshot restore, for sizing a sandbox or a resumed snapshot.

[1.3.1] - 2026-06-24 ​

Added ​

  • Agent Sandbox API (client.sandbox) — remote runtime containers with exec/code, lifecycle (start/stop/delete), file IO (fs.* and volume uploadFiles/listFiles/downloadFile), git.*, detached sessions.*, and snapshot/fork/restoreSnapshot/waitUntilRunning.
  • Realtime API (client.realtime) — WebSocket sessions with connect/url/twilioStreamUrl, the RealtimeConnection event API and respond() helper, optional voice (STT/TTS) round-trip, and realtime model presets (client.realtime.models).

Changed ​

  • Documented the full API surface on the docs site (previously README-only): Batches, Moderations, Spend & Budgets, Realtime, Agent Sandbox, plus LangChain and OpenTelemetry integration pages.

[1.3.0] - 2026-06-22 ​

Added ​

  • Agent Sandbox API (client.sandbox) — initial resource for remote runtime containers: create/list/get/delete, exec/code, waitUntilRunning, filesystem (fs.*: list/info/read/write/mkdir/delete/move/find/replace), git.* (clone/status/branches/checkout/add/commit/push/pull/log), and detached sessions.*. (Lifecycle start/stop, volume file IO, and snapshot/fork/restore followed in 1.3.1.)
  • reasoning_content / reasoning on chat messages, streamed and non-streamed — reasoning/"thinking" models' chain-of-thought, surfaced end to end including through the LangChain integration (additional_kwargs on AIMessage/AIMessageChunk).

[1.2.0] - 2026-06-03 ​

Added ​

  • Batch API (client.batches) — OpenAI-compatible async bulk inference: create/list/retrieve/cancel/items/results/resultsRaw.
  • Moderations API (client.moderations.create) — OpenAI-compatible content classification backed by guardrails.
  • Spend API (client.spend.report) and Budgets API (client.budgets — list/create/update/delete/status).

Removed ​

  • client.browserAgents (superseded by the browsers / browser sessions / per-browser MCP split).

[1.1.0] - 2026-05-21 ​

Added ​

  • Audio API (client.audio.transcriptions, audio.translations, audio.speech).
  • OCR API (client.ocr.extract).
  • Automations API (client.automations).
  • Crawler API (client.crawler + client.crawler.jobs).
  • JS Sandbox API (client.jsSandbox).
  • Reranker API (client.rerankers, Cohere-compatible).
  • MCP API (client.mcp.console, client.mcp.server(key)) with REST + JSON-RPC + SSE helpers.
  • Tracing streaming (startStream / appendEvent / endStream) and direct OTLP ingest (ingestOtlp).
  • File providers (client.files.providers) and binary client.files.download(...).

Changed ​

  • HttpClient now supports binary responses and multipart uploads.
  • Default baseURL is the host root. Legacy URLs ending in /api/client/v1 are normalised automatically.

Fixed ​

  • URL double-prefix bug when the default baseURL was used with resource paths that already include /api/client/v1.

[1.0.6] - 2026-05-14 ​

Added ​

  • Browser automation resources — client.browsers (profiles), client.browserSessions (Playwright-backed sessions: action/extract/snapshot/screenshot/screenshotLive/pdf/close), and client.browserMcp (per-browser MCP tool bridge: initialize/listTools). This split superseded the older client.browserAgents, which was removed in 1.2.0.

Changed ​

  • Clarified memory API docs/examples (base URL usage, added debug logging) and refined the MemorySource/MemoryItemStatus types.

[1.0.5] - 2026-03-25 ​

Housekeeping release. This commit ("Initial public release") is the earliest point in the SDK's public git history; no per-commit detail is available for what changed since 1.0.4.

[1.0.4] - 2026-02-20 ​

Published to npm; no corresponding commit survives in this repository's history — the visible git history begins after this release, at the 1.0.5 snapshot above. No further detail could be grounded in source.

1.0.2 - 2025-10-09 ​

Fixed ​

  • Documentation deployment configuration for GitHub Pages

1.0.0 - 2025-10-08 ​

Added ​

  • Initial release of Cognipeer Console SDK
  • Chat completions with streaming support
  • Embeddings API
  • Vector operations (Pinecone, Chroma, Qdrant)
  • File management with markdown conversion
  • Agent tracing and observability
  • Full TypeScript support
  • ESM and CommonJS builds
  • Comprehensive documentation

Features ​

  • OpenAI-compatible API
  • Type-safe client
  • Error handling
  • Request/response validation
  • Multi-provider support

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

© 2026 Cognipeer. All rights reserved.