Create Profile Schema

curl --request POST \ --url 'https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas' \ --header 'Authorization: Bearer <YOUR_API_KEY>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "description": "<string>", "attributes": [ { "name": "<string>", "description": "<string>" } ], "plan_version": "Pro" } '

Creates a user profile schema, defining the fields and descriptions included in the profile.

Request parameters

Parameter	Type	Required	Description
`name`	string	Yes	Profile schema name
`description`	string	No	Schema description, used to guide agent invocation
`attributes`	array	Yes	Profile field list, each item contains `name` and `description`
`plan_version`	string	No	`Pro` or `Lite`, defaults to Pro if not provided

Code examples

curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "用户基础画像",
    "description": "包含年龄和兴趣的用户信息",
    "attributes": [
      {"name": "年龄", "description": "用户年龄"},
      {"name": "爱好", "description": "用户的兴趣爱好"},
      {"name": "职业", "description": "用户职业"}
    ]
  }'

# response
{
  "profile_schema_id": "schema_xxx",
  "request_id": "a1b2c3d4-..."
}

After creation, pass profile_schema via AddMemory to extract the profile, then use GetUserProfile to retrieve it.

Request parameters

Code examples

Authorizations

Body

Response

​Request parameters

​Code examples

Authorizations

Body

Response

Request parameters

Code examples