Developer-friendly & type-safe Typescript SDK specifically catered to leverage supermemory API.
Important
This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
supermemory API: The Memory API for the AI era. OpenAPI operations include x-codeSamples for the official TypeScript and Python SDKs (Mintlify-compatible).
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add supermemorypnpm add supermemorybun add supermemoryyarn add supermemoryNote
This package is published as an ES Module (ESM) only. For applications using
CommonJS, use await import("supermemory") to import and use this package.
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
});
console.log(result);
}
run();This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
apiKey |
http | HTTP Bearer | SUPERMEMORY_API_KEY |
To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
});
console.log(result);
}
run();Available methods
- delete - Delete documents
- batchAdd - Batch add documents
- get - Get document
- update - Update document
- uploadFile - Upload file
- replaceWithFile - Replace document with file
- updateFile - Partially update document file
- forget - Forget memories by ID
- forgetMatching - Forget memories semantically
- list - List namespaces
- get - Get namespace settings
- update - Update namespace settings
- delete - Delete namespace
- getBuckets - Get profile buckets
- setBuckets - Add or update profile buckets
- deleteBuckets - Delete profile buckets
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
add- Add documentdocumentsBatchAdd- Batch add documentsdocumentsDelete- Delete documentsdocumentsGet- Get documentdocumentsReplaceWithFile- Replace document with filedocumentsUpdate- Update documentdocumentsUpdateFile- Partially update document filedocumentsUploadFile- Upload filelist- List resourcesmemoriesForget- Forget memories by IDmemoriesForgetMatching- Forget memories semanticallynamespacesDelete- Delete namespacenamespacesGet- Get namespace settingsnamespacesList- List namespacesnamespacesUpdate- Update namespace settingsorganizationGet- Get organization settingsorganizationUpdate- Update organization settingsprofile- Get profileprofilesDeleteBuckets- Delete profile bucketsprofilesGetBuckets- Get profile bucketsprofilesSetBuckets- Add or update profile bucketssearch- Search memories
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
Tip
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlobfunction innode:fs. - Bun: The native
Bun.filefunction produces a file handle that can be used for streaming file uploads. - Browsers: All supported browsers return an instance to a
Filewhen reading the value from an<input type="file">element. - Node.js v18: A file stream can be created using the
fileFromhelper fromfetch-blob/from.js.
import { openAsBlob } from "node:fs";
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.documents.uploadFile({
namespace: "user_alex",
body: {
file: await openAsBlob("example.file"),
supportingContext: "Focus on product decisions, dates, and owners.",
date: "2026-01-15",
},
});
console.log(result);
}
run();Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
});
console.log(result);
}
run();SupermemoryError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
error.message |
string |
Error message |
error.statusCode |
number |
HTTP response status code eg 404 |
error.headers |
Headers |
HTTP response headers |
error.body |
string |
HTTP body. Can be empty string if no body is returned. |
error.rawResponse |
Response |
Raw HTTP response |
error.data$ |
Optional. Some errors may contain structured data. See Error Classes. |
import { Supermemory } from "supermemory";
import * as errors from "supermemory/models/errors";
const supermemory = new Supermemory({
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
try {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.SupermemoryError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.ErrorResponse) {
console.log(error.data$.error); // string
console.log(error.data$.details); // string
}
}
}
}
run();Primary errors:
SupermemoryError: The base class for HTTP error responses.ErrorResponse: Generic error.ValidationErrorResponse: Body returned when request input fails schema validation. Status code400. *
Less common errors (6)
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from SupermemoryError:
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Supermemory } from "supermemory";
const supermemory = new Supermemory({
serverURL: "https://api.supermemory.ai",
apiKey: process.env["SUPERMEMORY_API_KEY"] ?? "",
});
async function run() {
const result = await supermemory.add({
namespace: "user_alex",
body: {
content: "Supermemory turns unstructured content into evolving memory.",
id: "my-doc-123",
supportingContext: "Focus on product decisions, dates, and owners.",
metadata: {
"source": "api-docs",
},
date: "2026-01-15",
},
});
console.log(result);
}
run();The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to:
- route requests through a proxy server using undici's ProxyAgent
- use the
"beforeRequest"hook to add a custom header and a timeout to requests - use the
"requestError"hook to log errors
import { Supermemory } from "supermemory";
import { ProxyAgent } from "undici";
import { HTTPClient } from "supermemory/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Supermemory({ httpClient: httpClient });You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Supermemory } from "supermemory";
const sdk = new Supermemory({ debugLogger: console });You can also enable a default debug logger by setting an environment variable SUPERMEMORY_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.