CreateMemory

Creates a long-term memory.

Operation description

• You can store specific information from conversations (memory nodes. For more information, see Long-term memory) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the CreateMemory operation to create a long-term memory and obtain the memoryId. Then pass the memoryId when you invoke the agent application through the API.

  NoteLong-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see Long-term memory.

• If you pass a memoryId, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the CreateMemoryNode operation to manually create memory nodes.

• This operation does not support idempotence.

Throttling: 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:CreateMemory	create	*All Resource *	None	None

Request syntax

POST /{workspaceId}/memories 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

Request parameters

Parameter	Type	Required	Description	Example
description	string	No	The description of the long-term memory. The description must be 1 to 50 characters in length and can contain letters, digits, and characters in the Unicode letter category (including Chinese characters). The description can also contain colons (:), underscores (_), periods (.), and hyphens (-).	我的大模型应用$APP_ID关于A用户的长期记忆体

Response elements

Element	Type	Description	Example
	object	Schema of Response
memoryId	string	The long-term memory ID. Store this value properly. It is required for all subsequent API operations related to this long-term memory. .	6bff4f317a14442fbc9f73d29dbxxxx
requestId	string	The request ID.	17204B98-xxxx-4F9A--2446A84821CA

Examples

Success response

JSON format

{
  "memoryId": "6bff4f317a14442fbc9f73d29dbxxxx",
  "requestId": "17204B98-xxxx-4F9A--2446A84821CA"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Memory.DescriptionInvalid	Input parameter description is invalid.	Memory's description 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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.