@coppermind/sdk

TypeScript SDK for Coppermind's managed cloud route family.

Coppermind's default product posture is local runtime first. This SDK is the right choice when you want to integrate directly with the managed route contract from your own application code.

Install

npm install @coppermind/sdk

React hooks are available from a separate subpath:

import { useCoppermind, useCoppermindIngest } from "@coppermind/sdk/hooks";

Create A Client

When you target the managed route family, an API key is required because this is a cloud-connected surface.

import { CoppermindClient } from "@coppermind/sdk";

const client = new CoppermindClient({
  apiKey: process.env.COPPERMIND_API_KEY!,
  baseUrl: "https://api.coppermindapi.com",
});

For local gateway development:

const client = new CoppermindClient({
  apiKey: process.env.COPPERMIND_API_KEY!,
  baseUrl: "http://127.0.0.1:4000",
});

Usage

const memory = await client.getMemory("user-123");

const results = await client.searchMemory({
  userId: "user-123",
  query: "What did we decide about React state?",
  limit: 5,
});

await client.ingest({
  userId: "user-123",
  data: [{ content: "User prefers TypeScript with strict mode" }],
});

const stats = await client.getStats("user-123");

await client.deleteMemory("user-123", ["episode-1"]);

Route Mapping

| SDK method | Managed route | |------------|---------------| | getMemory(userId) | GET /v1/memory | | searchMemory(query) | GET /v1/memory/search | | ingest(payload) | POST /v1/ingest | | getStats(userId) | GET /v1/stats | | deleteMemory(userId, episodeIds) | DELETE /v1/memory/delete |

API Notes

• getMemory returns { userId, fragments, total, context }
• searchMemory returns the same shape plus query
• ingest expects the modern { userId, data[] } body
• the managed route family decides whether the request resolves to hosted sync or BYODB

Development

cd sdk-js
npm install
npm run build
npm run lint