Get Profile Schema

Gets details of a specified profile schema, including field definitions and configuration information.

Method and endpoint

GET https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas/{profile_schema_id}

Request parameters

Parameter	Type	Required	Location	Description
`profile_schema_id`	string	Yes	Path	Profile schema ID
`memory_library_id`	string	No	Query	Memory library ID

Response

Field	Type	Description
`request_id`	string	Request ID
`name`	string	Profile schema name
`description`	string	Profile schema description
`plan_version`	string	Billing plan
`extract_scene`	string	Extraction mode
`attributes`	array	List of profile attributes
`attributes[].attribute_id`	string	Attribute ID
`attributes[].name`	string	Attribute name
`attributes[].description`	string	Attribute description

Code examples

cURL

curl -X GET "https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas/{profile_schema_id}" \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json"

Response example

{
  "attributes": [
    {"attribute_id": "04eb06f5f04a437b82d07ceb088103f9", "description": "The user's interests and hobbies", "name": "Hobbies"},
    {"attribute_id": "2eff4652a6bc47b0803635033b1e08dd", "description": "The user's occupation", "name": "Occupation"},
    {"attribute_id": "bb28e6cd522443fc9bf7e75b1377bf9d", "description": "The user's age", "name": "Age"}
  ],
  "description": "User information including age and interests",
  "extract_scene": "efficient",
  "name": "Basic user profile",
  "plan_version": "pro",
  "request_id": "5eb49009-6782-95f4-85da-c5f20d288d9a"
}

To update a schema, use UpdateProfileSchema.

​Method and endpoint

​Request parameters

​Response

​Code examples

​Response example

Method and endpoint

Request parameters

Response

Code examples

Response example