Skip to main content

Overview

Service address, protocol, request format, and response structure

Through the Memory API, you can programmatically write memories, search memories, and manage profile templates. All endpoints are served via the DashScope gateway.

Service address

https://dashscope.aliyuncs.com/api/v2/apps/memory/
All endpoints use the same base URL. Append the path shown on each API page to the base URL. For example, /add corresponds to https://dashscope.aliyuncs.com/api/v2/apps/memory/add.

Protocol

  • All endpoints use HTTPS only
  • Request and response bodies are JSON in UTF-8
  • Write and search use POST; list uses GET; update uses PATCH; delete uses DELETE

Common headers

HeaderRequiredDescription
AuthorizationYesBearer $DASHSCOPE_API_KEY, see Authentication
Content-TypeOnly for endpoints with a request bodyapplication/json

Response format

The only common field in successful responses is request_id. Other business fields vary by API. See the corresponding API page for details. Success:
{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Error:
{
  "code": "InvalidParameter",
  "message": "user_id is required",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Provide request_id when contacting support for faster resolution. See Error codes.

Pagination

List endpoints support pagination:
ParameterDescription
page_sizePage size
page_numPage number, starting from 1
Memory begins commercial billing on August 20, 2026. Add and Search calls distinguish Pro and Lite plan versions. See Billing.
View AddMemory to start.
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration