Complete API directory for long-term memory: common request information, a full API overview, and usage limits. See each API's dedicated page for request parameters, responses, and sample code.
This document is the directory overview of all long-term memory (Memory) APIs. For feature introduction and usage guides, see Memory and Long-term memory API.
For protocol conventions, common request/response formats, and pagination, see API overview. For authentication details, see Authentication. For error responses, see Error codes.
Factual memory:
User profile:
Throttling (per Alibaba Cloud account):
Generated memory fragments and user profiles currently have no expiration date. To request a quota increase, submit a ticket. For more information, see Rate limits.
Common request information
| Parameter | Description |
|---|---|
| Base URL | https://dashscope.aliyuncs.com/api/v2/apps/memory/ |
| Authentication | Add Authorization: Bearer $DASHSCOPE_API_KEY to the request header. To obtain an API Key, see Get API Key |
| Content-Type | application/json |
API overview
Factual memory:
| API name | HTTP method | Path | Description |
|---|---|---|---|
| AddMemory | POST | /add | Add a factual memory |
| AddMemoryAsync | POST | /add-async | Submit a memory extraction task asynchronously |
| GetEvent | GET | /events/{event_id} | Get asynchronous task event details |
| ListMemory | GET | /memory_nodes | List factual memories |
| SearchMemory | POST | /memory_nodes/search | Search factual memories |
| GetMemoryNode | GET | /memory_nodes/{memory_node_id} | Get a memory node |
| GetSkillExport | GET | /skill/export/{memory_node_id} | Export a skill memory node |
| UpdateMemory | PATCH | /memory_nodes/{memory_node_id} | Update a factual memory |
| DeleteMemory | DELETE | /memory_nodes/{memory_node_id} | Delete a factual memory |
| API name | HTTP method | Path | Description |
|---|---|---|---|
| CreateProfileSchema | POST | /profile_schemas | Create a profile schema |
| ListProfileSchemas | GET | /profile_schemas | List profile schemas |
| GetProfileSchema | GET | /profile_schemas/{profile_schema_id} | Get profile schema details |
| UpdateProfileSchema | PATCH | /profile_schemas/{profile_schema_id} | Update a profile schema |
| GetUserProfile | GET | /profile_schemas/{profile_schema_id}/user_profile | Get a user profile |
Usage limits
Throttling (per Alibaba Cloud account):
| API | Limit |
|---|---|
| All APIs | 3,000 QPM in total |
| Factual memory add API | 120 QPM |
| Factual memory search API | 300 QPM |