List Profile Schemas

Paginated query of all profile schemas for the current user.

Method and endpoint

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

Request parameters

Parameter	Type	Required	Location	Description
`page_num`	integer	No	Query	Page number; defaults to 1
`page_size`	integer	No	Query	Number of schemas per page; defaults to 10
`memory_library_id`	string	No	Query	Memory library ID

Response

Field	Type	Description
`profile_schemas`	array	List of profile schemas
`profile_schemas[].profile_schema_id`	string	Profile schema ID
`profile_schemas[].name`	string	Profile schema name
`profile_schemas[].description`	string	Profile schema description
`profile_schemas[].plan_version`	string	Billing plan
`profile_schemas[].extract_scene`	string	Extraction mode
`request_id`	string	Request ID
`total`	integer	Total number of profile schemas

Code examples

cURL

curl -X GET "https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas?page_size=10&page_num=1" \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json"

Response example

{
  "profile_schemas": [
    {
      "description": "User information including age and interests",
      "extract_scene": "efficient",
      "name": "Basic user profile",
      "plan_version": "pro",
      "profile_schema_id": "50edf54eaa5842e891d959ae115205be"
    },
    {
      "description": "Default profile schema created by the system",
      "extract_scene": "efficient",
      "name": "Default profile",
      "plan_version": "pro",
      "profile_schema_id": "976e2e6e59f64ed0b25e6ca0268624bb"
    }
  ],
  "request_id": "3c46983f-85fd-92a5-8440-2e459cc91b2f",
  "total": 2
}

To view details of a single schema, use GetProfileSchema.

​Method and endpoint

​Request parameters

​Response

​Code examples

​Response example

Method and endpoint

Request parameters

Response

Code examples

Response example