Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RetrieveMemoryRecords

Searches for and retrieves memory records from a memory store based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the RetrieveMemoryRecords permission.

Request Syntax


POST /memories/memoryId/retrieve HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "namespace": "string",
   "nextToken": "string",
   "searchCriteria": { 
      "memoryStrategyId": "string",
      "searchQuery": "string",
      "topK": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

memoryId

The identifier of the memory store from which to retrieve memory records.

Length Constraints: Minimum length of 12.

Pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

namespace

The namespace to filter memory records by. If specified, only memory records in this namespace are searched.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [a-zA-Z0-9/*][a-zA-Z0-9-_/*]*

Required: Yes

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

Required: No

searchCriteria

The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.

Type: SearchCriteria object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "memoryRecordSummaries": [ 
      { 
         "content": { ... },
         "createdAt": number,
         "memoryRecordId": "string",
         "memoryStrategyId": "string",
         "namespaces": [ "string" ],
         "score": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

memoryRecordSummaries

The list of memory record summaries that match the search criteria, ordered by relevance.

Type: Array of MemoryRecordSummary objects

nextToken

The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

HTTP Status Code: 403

InvalidInputException

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

HTTP Status Code: 400

ResourceNotFoundException

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

HTTP Status Code: 404

ServiceException

The service encountered an internal error. Try your request again later.

HTTP Status Code: 500

ServiceQuotaExceededException

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

HTTP Status Code: 402

ThrottledException

The request was denied due to request throttling. Reduce the frequency of requests and try again.

HTTP Status Code: 429

ValidationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

HTTP Status Code: 400