@redis-iris/agent-memory

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @redis-iris/agent-memory API.

Summary

MemoryDataPlaneServer: API for managing Redis Agent Memory (RAM) data plane operations.

Authentication:

• Cloud deployments require Authorization: Bearer <store-api-key>, where the store API key is obtained from Redis Cloud Agent Memory.
• On-prem deployments run with authentication disabled.

Table of Contents

• @redis-iris/agent-memory
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Global Parameters
  • Retries
  • Error Handling
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @redis-iris/agent-memory

PNPM

pnpm add @redis-iris/agent-memory

Bun

bun add @redis-iris/agent-memory

Yarn

yarn add @redis-iris/agent-memory

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Add a session event

Append a chat turn to a session

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.addSessionEvent({
    actorId: "<id>",
    role: "SYSTEM",
    content: [
      {
        text: "<value>",
      },
    ],
    createdAt: new Date("2026-04-11T06:37:17.315Z"),
  });

  console.log(result);
}

run();

Get session memory

Retrieve the conversation context for a session

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.getSessionMemory("<id>");

  console.log(result);
}

run();

Create long-term memories

Store facts and knowledge in bulk

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.bulkCreateLongTermMemories({
    memories: [],
  });

  console.log(result);
}

run();

Search long-term memory

Run a semantic search with optional filtering

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.searchLongTermMemory();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | ---------------------- | | apiKey | http | HTTP Bearer | AGENT_MEMORY_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.health();

  console.log(result);
}

run();

Available Resources and Operations

AgentMemory SDK

• health - Return information about the operational status of the service.
• bulkDeleteLongTermMemories - Deletes long-term memories in bulk by their IDs.
• bulkCreateLongTermMemories - Creates long-term memories in bulk.
• searchLongTermMemory - Runs a semantic search on long-term memory with filtering options.
• getLongTermMemory - Returns a long-term memory by its ID.
• updateLongTermMemory - Partially updates a long-term memory by its ID.
• listSessions - Returns a paginated list of session IDs for a store.
• addSessionEvent - Appends a single event to a session. Creates the session if it does not exist. If sessionId is omitted, the server generates one.
• deleteSessionMemory - Deletes the session memory for a session.
• getSessionMemory - Returns the session memory for a session.
• deleteSessionEvent - Deletes a single event from a session by event ID.
• getSessionEvent - Returns a single event from a session by event ID.

Standalone functions

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.

• addSessionEvent - Appends a single event to a session. Creates the session if it does not exist. If sessionId is omitted, the server generates one.
• bulkCreateLongTermMemories - Creates long-term memories in bulk.
• bulkDeleteLongTermMemories - Deletes long-term memories in bulk by their IDs.
• deleteSessionEvent - Deletes a single event from a session by event ID.
• deleteSessionMemory - Deletes the session memory for a session.
• getLongTermMemory - Returns a long-term memory by its ID.
• getSessionEvent - Returns a single event from a session by event ID.
• getSessionMemory - Returns the session memory for a session.
• health - Return information about the operational status of the service.
• listSessions - Returns a paginated list of session IDs for a store.
• searchLongTermMemory - Runs a semantic search on long-term memory with filtering options.
• updateLongTermMemory - Partially updates a long-term memory by its ID.

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set storeId to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like bulkDeleteLongTermMemories. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. Global parameters can also be set via environment variable.

| Name | Type | Description | Environment | | ------- | ------ | ---------------------- | --------------------- | | storeId | string | The storeId parameter. | AGENT_MEMORY_STORE_ID |

Example

import { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.bulkDeleteLongTermMemories({
    memoryIds: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  });

  console.log(result);
}

run();

Retries

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 { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.health({
    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 { AgentMemory } from "@redis-iris/agent-memory";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  const result = await agentMemory.health();

  console.log(result);
}

run();

Error Handling

AgentMemoryError 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. |

Example

import { AgentMemory } from "@redis-iris/agent-memory";
import * as errors from "@redis-iris/agent-memory/models/errors";

const agentMemory = new AgentMemory({
  serverURL: "https://api.example.com",
  storeId: "<id>",
  apiKey: "<AGENT_MEMORY_API_KEY>",
});

async function run() {
  try {
    const result = await agentMemory.bulkDeleteLongTermMemories({
      memoryIds: [
        "<value 1>",
        "<value 2>",
        "<value 3>",
      ],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AgentMemoryError) {
      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.BadRequestErrorResponseContent) {
        console.log(error.data$.title); // string
        console.log(error.data$.status); // number
        console.log(error.data$.detail); // string
        console.log(error.data$.instance); // string
        console.log(error.data$.type); // models.BadRequestErrorType
      }
    }
  }
}

run();

Error Classes

Primary errors:

• AgentMemoryError: The base class for HTTP error responses.
  • BadRequestErrorResponseContent: Request validation or input decoding failed. Status code 400. *
  • AuthenticationErrorResponseContent: Authentication credentials are missing, malformed, or invalid. Status code 401. *
  • ForbiddenErrorResponseContent: The caller is authenticated but not allowed to access the requested resource. Status code 403. *
  • NotFoundErrorResponseContent: The requested resource does not exist. Status code 404. *
  • TimeoutErrorResponseContent: The request timed out before the service could complete it. Status code 408. *
  • PayloadTooLargeErrorResponseContent: The request payload exceeds the maximum supported size. Status code 413. *
  • FailedDependencyErrorResponseContent: A dependent resource required to process the request is unavailable or unhealthy. Status code 424. *
  • TooManyRequestsErrorResponseContent: The service rejected the request because rate limits were exceeded. Status code 429. *
  • UnexpectedErrorResponseContent: The service failed with an unexpected internal error. Status code 500. *

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 AgentMemoryError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Custom HTTP Client

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 { AgentMemory } from "@redis-iris/agent-memory";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@redis-iris/agent-memory/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 AgentMemory({ httpClient: httpClient });

Debugging

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 { AgentMemory } from "@redis-iris/agent-memory";

const sdk = new AgentMemory({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable AGENT_MEMORY_DEBUG to true.

Development

Maturity

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.

Contributions

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.

SDK Created by Speakeasy