GetMemory

Retrieves the description of a specified long-term memory.

Operation description

• This operation is idempotent.

Rate limit: Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.

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:GetMemory	get	*All Resource *	None	None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The ID of the workspace to which the long-term memory belongs. For information about how to obtain the workspace ID, see How to use a workspace.	llm-3z7uw7fwz0vexxxx
memoryId	string	Yes	The ID of the long-term memory, which corresponds to the memoryId returned by the CreateMemory operation.	6bff4f317a14442fbc9f73d29dbxxxx

Request parameters

Parameter	Type	Required	Description	Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
description	string	The description of the long-term memory.	The long-term memory of my LLM application $APP_ID about user A
memoryId	string	The ID of the long-term memory.	6bff4f317a14442fbc9f73d29dbdxxxx
requestId	string	The request ID.	6a71f2d9-f1c9-913b-818b-11402910xxxx
workspaceId	string	The ID of the workspace to which the long-term memory belongs.	llm-3z7uw7fwz0vexxxx

Examples

Success response

JSON format

{
  "description": "我的大模型应用$APP_ID关于A用户的长期记忆体",
  "memoryId": "6bff4f317a14442fbc9f73d29dbdxxxx",
  "requestId": "6a71f2d9-f1c9-913b-818b-11402910xxxx",
  "workspaceId": "llm-3z7uw7fwz0vexxxx"
}

Error codes

HTTP status code	Error code	Error message	Description
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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.