Skip to main content
Memory API

API 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 with the /memory/ path prefix.

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-TypeYesapplication/json

Response format

All endpoints return a unified JSON structure. Success: 
{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "memory_nodes": [
    {
      "memory_node_id": "node_xxx",
      "content": "User needs hydration reminder at 9 AM daily"
    }
  ]
}
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.
Overview
Managed Agent API
Sandbox API
Memory API
Flow Agent API
RAG API
Connector API
Framework Integration
Assistant API (Deprecating)
  • Overview