Use the Redis Agent Memory API and SDK

Learn to use the Redis Agent Memory API for agent memory and semantic memory search.

Use the Agent Memory API from your client app to store and retrieve agent memory information.

You can use any standard REST client or library to access the API. If your app is written in Python, you can also use the Agent Memory Software Development Kit (SDK) to access the API.

Authentication

To access the Agent Memory API, you need:

• Agent Memory API endpoint
• an Agent Memory API user key
• a Store ID

When you call the API, you need to pass the Agent Memory API key in the Authorization header as a Bearer token and the store ID as the storeId path parameter.

For example:

curl -s -X GET "https://$HOST/v1/stores/$STORE_ID/session-memory" \
    -H "accept: application/json" \
    -H "Authorization: Bearer $API_KEY" 

This example expects several variables to be set in the shell:

• $HOST - the Agent Memory API endpoint
• $STORE_ID - the Store ID of your Agent Memory service
• $API_KEY - The Agent Memory API token

Examples

Add session event

Use POST /v1/stores/{storeId}/session-memory/events to add an event to a session in short-term memory. If a session doesn't exist yet, it will be created.

POST /v1/stores/{storeId}/session-memory/events
{
    "sessionId": "abcd-efgh",
    "actorId": "user-name",
    "role": "USER",
    "content": [
        {
            "text": "I'm planning a trip to Japan next month."
        }
    ],
    "createdAt": "2026-05-02T18:15:06Z",
    "metadata": {
        "browser": "Chrome",
        "source": "web-chat"
      }
}

Use this endpoint to store conversations between your users and your AI agent. You can use the metadata object to store additional metadata for your application.

The Agent Memory model will automatically promote relevant short-term memories to long-term memory.

Add Long-term memories

You may want to add one or more long-term memories to add specific preference information.

Use POST /v1/stores/{storeId}/long-term-memory/ to add one or more long-term memories to long-term memory storage.

POST /v1/stores/{storeId}/long-term-memory
{
    "memories": [
        {
            "id": "cofIXpuMmg",
            "text": "The user prefers vegetarian food.",
            "memoryType": "episodic",
            "sessionId": "abcd-efgh",
            "ownerId": "user-name",
        }
    ]
}

Search Long-term memories

Use POST /v1/stores/{storeId}/long-term-memory/search to search for long-term memories.

POST /v1/stores/{storeId}/long-term-memory/search
{
    "text": "user preferences",
    "similarityThreshold": 0.48725898820184166,
    "filter": {
        "sessionId": {
            "eq": "abcd-efgh"
        },
        "ownerId": {
            "in": [
                "user1",
                "user2"
            ]
        }
    },
    "filterOp": "any"
}

In the filter object of the request body, you can filter the search by any of the following values:

For all values, you must set only one of these operators: