REredis
Agent Memory - Stores

Get memory store

Changed on

Get the Agent Memory store identified by store Id

get/v1/memory-stores/{storeId}

Request

  • Base URL
    https://api.redislabs.com
  • URL
    https://api.redislabs.com/v1/memory-stores/{storeId}
  • Auth
    API key in header x-api-key and API key in header x-api-secret-key and API key in header x-auth-token

Path parameters

storeIdstring required

Memory store ID.

Response

Memory store returned.

storeIdstring
namestring
createdAtstring date-time
databaseIdstring
databaseNamestring
databaseProviderstring
databaseRegionstring
databaseAccessCidrsstring[]
subscriptionIdstring
endpointstring
extractionStrategy'INSTRUCT'

How long-term memories are extracted from sessions. INSTRUCT uses LLM tool calling to create, update and delete granular memories

status'PROVISIONING' | 'READY' | 'UNAVAILABLE'

Lifecycle status of the memory store

errorMessagestring
errorMessageTimestampnumber double

Example response

{
  "shortMemory": {
    "ttlSeconds": 86400
  },
  "longTermMemory": {
    "ttlSeconds": 31536000,
    "embedding": {
      "provider": "openai",
      "model": "gpt-4o-mini"
    }
  },
  "llm": {
    "provider": "openai",
    "model": "gpt-4o-mini"
  },
  "endpoints": [
    {
      "provider": "AWS",
      "region": "us-east-1"
    }
  ],
  "summarization": {
    "enabled": true,
    "triggerStrategy": "event_count",
    "eventCount": {
      "threshold": 50,
      "retainCount": 10
    }
  },
  "longTermMemoryExclusions": {
    "enabled": true,
    "semantic": {
      "enabled": true,
      "prompt": "Do not remember payment card numbers or home addresses"
    },
    "builtInDetectors": {
      "enabled": true,
      "detectors": [
        {
          "id": "credit-card",
          "enabled": true,
          "action": "redact"
        }
      ]
    },
    "customDetectors": {
      "enabled": true,
      "detectors": [
        {
          "name": "internal-ticket-id",
          "enabled": true,
          "action": "redact",
          "matcher": {
            "kind": "regex",
            "regex": {
              "pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b"
            }
          }
        }
      ]
    }
  },
  "customMemoryTypes": [
    {
      "name": "travel_preference",
      "description": "Preferences the user expressed about travel",
      "fields": [
        {
          "name": "preferred_airline",
          "description": "Airline the user prefers to fly with",
          "type": "str"
        }
      ],
      "extractionStrategy": {
        "prompt": "Extract the user's travel preferences",
        "enabled": true
      }
    }
  ],
  "extractionCadence": {
    "activeIntervalSeconds": 120
  }
}

Changes