CreateMemory-阿里云帮助中心

Operation description

You can store specific information from a conversation in a long-term memory, which is saved as memory segments. An agent application can then reference this information in subsequent conversations. For more information, see Long-term memory. This process is not automatic. You must first call the CreateMemory operation to create a long-term memory and obtain a memoryId. Then, pass the memoryId when you call an agent application through an API
Note
Long-term memory does not support storing or managing user profiles. Use the console for these operations. For more information, see Long-term memory.
If you provide a memoryId, the system automatically creates memory segments (MemoryNode) in the specified long-term memory based on the conversation history. Alternatively, you can call the CreateMemoryNode operation to create memory segments manually.
This operation is not idempotent.

Throttling: To avoid triggering throttling controls, ensure that the interval between requests is at least 1 second. If a request is throttled, retry it 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.

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

sfm:CreateMemory

create

*All Resource

*

None

Request syntax

POST /{workspaceId}/memories HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The ID of the workspace to which the long-term memory belongs. For more information about how to obtain the workspace ID, see Use workspaces.	llm-us9hjmt32nysdm5v
description	string	No	The description of the long-term memory. The description must be 1 to 50 characters long. It can contain Unicode letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	我的大模型应用$APP_ID关于A用户的长期记忆体

Response elements

Parameter	Type	Description	Example
	object	The response schema.
memoryId	string	The ID of the long-term memory. Note Save this ID. It is required for all subsequent API operations related to this long-term memory.	6bff4f317a14442fbc9f73d29dbd5fc3
requestId	string	The request ID.	6a71f2d9-f1c9-913b-818b-114029103cad

Examples

Success response

JSON format

{
  "memoryId": "6bff4f317a14442fbc9f73d29dbd5fc3",
  "requestId": "6a71f2d9-f1c9-913b-818b-114029103cad"
}

Error codes

HTTP status code	Error code	Error message
400	Memory.DescriptionInvalid	Input parameter description is invalid.
500	Memory.InternalError	Memory service inner exception.
404	Memory.MemoryIdNotFound	Memory Id not exist or is not authorized.

See for a complete list.

Release notes

See Release Notes for a complete list.