Registry / ai-ml / convo-sdk

convo-sdk

JSON →
library1.0.47jsnpmunverified

Convo SDK is a drop-in LangGraph-compatible checkpointer providing persistent memory and message logging for AI agents. It uses PostgreSQL as the backend for cloud-native state persistence, enabling multi-thread management and historical checkpointing. Version 1.0.47 (as of early 2025) is actively maintained, releases weekly. Key differentiator: eliminates need for manual database configuration, simplifies agent memory with a single import, and supports dynamic thread IDs.

npm install convo-sdk
INSTALL
IMPORT
SIG · CONVO-SDK
C
convo-sdk
ai-mljavascriptv1.0.47
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Convo
import { Convo } from 'convo-sdk'
const Convo = require('convo-sdk')
ESM-only package, does not support CommonJS require().
Convo
import { Convo } from 'convo-sdk'
import Convo from 'convo-sdk'
Named export only; default import will result in undefined.
Convo
import { Convo } from 'convo-sdk'
import * as Convo from 'convo-sdk'
Namespace import does not work because Convo is a named export, not a module namespace.

Shows SDK initialization, thread creation, and checkpointer retrieval for LangGraph integration.

import { Convo } from 'convo-sdk'; const convo = new Convo({ apiKey: process.env.CONVO_API_KEY ?? '' }); async function main() { const thread_id = await convo.newThread(); const checkpointer = convo.checkpointer({ thread_id }); // Assuming workflow is already compiled from LangGraph // const graph = workflow.compile({ checkpointer }); // await graph.invoke({ messages: [{ role: 'user', content: 'Hello' }] }, { configurable: { thread_id } }); console.log(`Thread ${thread_id} created and checkpointer ready.`); } main().catch(console.error);
Debug
Known issues
breakingConvo SDK is ESM-only. All imports must use ES module syntax; CommonJS require() will throw an error.
fix
Use import statements (e.g., import { Convo } from 'convo-sdk') and set "type": "module" in your package.json.
affects: >=1.0.0
gotchaThe Convo constructor does not support a default import. Attempting import Convo from 'convo-sdk' will yield undefined.
fix
Use named import: import { Convo } from 'convo-sdk'.
affects: >=1.0.0
gotchaThe checkpointer method must be called after the SDK is fully initialized (async init may be future requirement). Ensure convo instance is ready before checkpointer call.
fix
Always await any async initialization if present; currently constructor is sync but future versions may require async init.
affects: >=1.0.0
deprecatedPassing thread_id as a separate parameter in graph.invoke configurable is the recommended approach; setting thread_id only at checkpointer creation may be deprecated in favor of dynamic passing.
fix
Prefer passing thread_id in configurable during graph.invoke for flexibility.
affects: >=1.0.0
gotchaThe API key must be set before using any SDK methods. Missing or invalid key will cause unauthorized errors.
fix
Set process.env.CONVO_API_KEY or provide apiKey in constructor options.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'convo-sdk'
Package not installed or installation failed.
fix
Run 'npm install convo-sdk' in your project directory.
TypeError: Cannot read properties of undefined (reading 'checkpointer')
Convo was imported as default instead of named export.
fix
Change import to: import { Convo } from 'convo-sdk'.
Error: The module 'convo-sdk' exports a default, not a named export 'Convo'
Use of CommonJS require() on an ESM-only package.
fix
Switch to ESM: use import { Convo } from 'convo-sdk' and ensure package.json has 'type': 'module'.
Error: Unauthorized: Invalid API key
Missing or incorrect API key in Convo constructor.
fix
Set a valid CONVO_API_KEY environment variable or pass apiKey option.
Upgrade
Version history
1.0.47latest on npm
Audit
Dependencies
langgraphrequiredConvo's checkpointer integrates directly with LangGraph's compile API
Agent activity
23 hits · last 30 days
node
20
Resources
convo-sdk — npm install convo-sdk · libregistry