SearchMemories - PolarDB - Alibaba Cloud Documentation Center

Retrieves memories.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:SearchMemories

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-**************
Query	string	Yes	The search query.	who are you
MemoryUserId	string	Yes	The memory user ID.	user1
MemoryAgentId	string	No	The memory agent ID.	agent1
TopK	string	No	Specifies the number of top results to return.	3
CreateTimeBegin	string	No	The start time for memory creation.	yyyy-MM-ddTHH:mm:ssZ
CreateTimeEnd	string	No	The end time for memory creation.	yyyy-MM-ddTHH:mm:ssZ
		No	The page number.
		No	The number of records per page.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
Results	array<object>	The list of results.
	object	The list of results.
Id	string	The memory ID.	423
Memory	string	The memory content.	xxx
Metadata	string	The metadata.	{\"tags\":\"Issue_date_2023-11-30,VD_现行有效\"}
Score	string	The score.	12
CreateTime	string	The creation time.	2025-09-26T08:25:44Z
UpdateTime	string	The update time.	2025-10-16T02:27:33Z
MemoryUserId	string	The user to whom the memory belongs.	user1
MemoryAgentId	string	The agent to which the memory belongs.	agent1
Total	string
Page	string
PageSize	string
TotalPages	string

Examples

Success response

JSON format

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "Results": [
    {
      "Id": "423",
      "Memory": "xxx",
      "Metadata": "{\\\"tags\\\":\\\"Issue_date_2023-11-30,VD_现行有效\\\"}",
      "Score": "12",
      "CreateTime": "2025-09-26T08:25:44Z",
      "UpdateTime": "2025-10-16T02:27:33Z",
      "MemoryUserId": "user1",
      "MemoryAgentId": "agent1"
    }
  ],
  "Total": "",
  "Page": "",
  "PageSize": "",
  "TotalPages": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.