# RetrieveMemoryRecords
<a name="API_RetrieveMemoryRecords"></a>

Searches for and retrieves memory records from an AgentCore Memory resource 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 `bedrock-agentcore:RetrieveMemoryRecords` permission.

## Request Syntax
<a name="API_RetrieveMemoryRecords_RequestSyntax"></a>

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

{
   "maxResults": number,
   "namespace": "string",
   "namespacePath": "string",
   "nextToken": "string",
   "searchCriteria": { 
      "memoryStrategyId": "string",
      "metadataFilters": [ 
         { 
            "left": { ... },
            "operator": "string",
            "right": { ... }
         }
      ],
      "searchQuery": "string",
      "topK": number
   }
}
```

## URI Request Parameters
<a name="API_RetrieveMemoryRecords_RequestParameters"></a>

The request uses the following URI parameters.

 ** [memoryId](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-uri-memoryId"></a>
The identifier of the AgentCore Memory resource 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
<a name="API_RetrieveMemoryRecords_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-maxResults"></a>
The maximum number of results to return in a single call. The default value is 20.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespace](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-namespace"></a>
The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9/*][a-zA-Z0-9-_/*]*(?::[a-zA-Z0-9-_/*]+)*[a-zA-Z0-9-_/*]*`   
Required: No

 ** [namespacePath](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-namespacePath"></a>
Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9/*][a-zA-Z0-9-_/*]*(?::[a-zA-Z0-9-_/*]+)*[a-zA-Z0-9-_/*]*`   
Required: No

 ** [nextToken](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-nextToken"></a>
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](#API_RetrieveMemoryRecords_RequestSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-request-searchCriteria"></a>
The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.  
Type: [SearchCriteria](API_SearchCriteria.md) object  
Required: Yes

## Response Syntax
<a name="API_RetrieveMemoryRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Response Elements
<a name="API_RetrieveMemoryRecords_ResponseElements"></a>

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](#API_RetrieveMemoryRecords_ResponseSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-response-memoryRecordSummaries"></a>
The list of memory record summaries that match the search criteria, ordered by relevance.  
Type: Array of [MemoryRecordSummary](API_MemoryRecordSummary.md) objects

 ** [nextToken](#API_RetrieveMemoryRecords_ResponseSyntax) **   <a name="BedrockAgentCore-RetrieveMemoryRecords-response-nextToken"></a>
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
<a name="API_RetrieveMemoryRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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

## See Also
<a name="API_RetrieveMemoryRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agentcore-2024-02-28/RetrieveMemoryRecords)