Skip to main content

List Skills

Lists custom and official Skills with pagination and filters by source and keyword.

Endpoint

GET /api/v1/skills Lists custom and official Skills with pagination.

Query parameters

ParameterTypeDefaultDescription
typestring—OFFICIAL or CUSTOMER. Case-sensitive. If omitted, queries both types
keywordsstring—Keyword. Ignored if blank after trimming
pageNointeger1Page number. Minimum 1
pageSizeinteger20Number of items per page. Valid values: 1 to 100
  • type=OFFICIAL: returns only non-deleted official Skills with the active status.
  • type=CUSTOMER: returns non-deleted custom Skills under the primary account and workspace, including checking and rejected statuses.
  • If type is omitted, returns official and custom Skills in one response. total is the total of both types.

Response

data is a page object. Each item in items is a SkillDTO.
FieldTypeDescription
itemsarray<SkillDTO>Skills on the current page
totallongTotal number of matching Skills
page_nointegerCurrent page number
page_sizeintegerNumber of items per page
If no data is found, items is an empty array and total is 0.

Example

# Official and custom Skills
curl "https://{workspace_id}.cn-beijing.maas.aliyuncs.com/api/v1/skills?pageNo=1&pageSize=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

# Custom Skills filtered by keyword
curl "https://{workspace_id}.cn-beijing.maas.aliyuncs.com/api/v1/skills?type=CUSTOMER&keywords=pdf&pageNo=1&pageSize=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "success": true,
  "error_code": null,
  "error_msg": null,
  "data": {
    "items": [
      {
        "id": "skill_abc123",
        "display_name": "My Custom Skill",
        "display_description": "Description",
        "source": "customer",
        "status": "active",
        "latest_version": "1.2",
        "classification": null,
        "meta_info": null,
        "created_at": "2026-06-15T08:23:11Z",
        "updated_at": "2026-06-15T08:23:11Z"
      }
    ],
    "total": 35,
    "page_no": 1,
    "page_size": 20
  },
  "request_id": "15a89d4c-f142-4e00-a9f7-b088442417c9"
}
The list is updated asynchronously. After a Skill is created, deleted, or its status changes, the list may take a moment to reflect the latest state. Use Get a Skill as the source of truth.

Errors

HTTP statuserror_codeDescription
401WORKSPACE_ID_ILLEGALIdentity information is missing or invalid
400INVALID_PARAMETERtype is not OFFICIAL or CUSTOMER, or pageNo or pageSize is not an integer, is out of range, or exceeds the pagination limit
500SYSTEM_ERRORThe query failed or an internal error occurred