ListMemoryNodes

Retrieves a list of memory nodes.

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.

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
sfm:ListMemoryNodes	list	*All Resource *	None	None

Request syntax

GET /{workspaceId}/memories/{memoryId}/memoryNodes HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The workspace ID.	llm-us9hjmt32nysdm5v
memoryId	string	Yes	The long-term memory ID.	6bff4f317a14442fbc9f73d29dbd5fc3

Request parameters

Parameter	Type	Required	Description	Example
maxResults	integer	No	The maximum number of results to return.	20
nextToken	string	No	The pagination token returned from a previous request. If specified, the query results are paginated based on the previous request.	dc270401186b433f975d7e1faaa34e0e

Response elements

Element	Type	Description	Example
	object	Schema of Response
maxResults	integer	The maximum number of results returned.	20
memoryNodes	array<object>	The array of memory nodes.
	object
content	string	The content of the memory node.	用户喜欢吃西红柿炒鸡蛋
memoryNodeId	string	The memory node ID.	68de06c95368463a8be4a84efc872cc5
nextToken	string	The token used for token-based pagination.	dc270401186b433f975d7e1faaa34e0e
requestId	string	The request ID.	6a71f2d9-f1c9-913b-818b-114029103cad
totalCount	integer	The total number of memory nodes.	100

Examples

Success response

JSON format

{
  "maxResults": 20,
  "memoryNodes": [
    {
      "content": "用户喜欢吃西红柿炒鸡蛋\n",
      "memoryNodeId": "68de06c95368463a8be4a84efc872cc5"
    }
  ],
  "nextToken": "dc270401186b433f975d7e1faaa34e0e\n",
  "requestId": "6a71f2d9-f1c9-913b-818b-114029103cad\n",
  "totalCount": 100
}

Error codes

HTTP status code	Error code	Error message	Description
400	Memory.MaxResultsInvalid	Input parameter maxResults is invalid.	Input parameter maxResults is invalid.
400	Memory.MemoryNodeContentInvalid	Memory node content is invalid.	Memory node content is invalid.
400	Memory.NextTokenInvalid	Input parameter nextToken is invalid.	The input nextToken is invalid.
500	Memory.InternalError	Memory service inner exception.	Memory service inner exception.
404	Memory.MemoryIdNotFound	Memory Id not exist or is not authorized.	memoryId not found
404	Memory.MemoryNodeNotFound	MemoryNode not found.	MemoryNode not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.