Help Center/ Workspace/ API Reference/ Workspace APIs/ Common Skills/ Listing Common Skills (Read-Only)
Updated on 2026-09-11 GMT+08:00
View PDF
Share

Listing Common Skills (Read-Only)

Function

An enterprise tenant lists common skills (read-only). Filtering by category or status is supported.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:skill:listCommon

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/common-skills

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset. The default value is 0.

limit

No

Integer

Page size. The default value is 20.

category

No

String

Skill category.

status

No

String

Skill status.

skill_name

No

String

Skill name (fuzzy match of slug, display_name, and alias_name).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Language, which is used for internationalization.

  • en-us: English.

  • zh-cn: Chinese.

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total quantity.

items

Array of SkillListItemVO objects

Common skills.
Table 5 SkillListItemVO

Parameter

Type

Description

id

String

Skill ID.

slug

String

Skill slug.

display_name

String

Skill name.

alias_name

String

Alias.

category

String

Skill category.

description

String

Skill description.

tags

Array of strings

Skill tag.

status

String

Skill status.

visibility_scope

String

Visibility scope.

current_package_id

String

ID of the skill package that is currently in effect.

current_version

String

Current effective version.

current_revision

Integer

Revision number of the currently effective version.

cover

String

Base64-encoded skill cover image.

source

String

Skill source.

support_os_types

Array of strings

List of supported OS types.

create_time

String

Creation time (UTC time in ISO 8601 format).

update_time

String

Update time (UTC time in ISO 8601 format).

attach_instance_number

Integer

Number of bound instances.

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 8 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 10 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 12 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

/v3/ai-agents/common-skills?offset=0&limit=20&category=WEB_SEARCH&status=ACTIVE

Example Responses

Status code: 200

{
  "items" : [ {
    "id" : "skill-uuid-001",
    "slug" : "web-search-v1",
    "display_name" : "Web Search",
    "alias_name" : "Web Search",
    "category" : "WEB_SEARCH",
    "description" : "Multi-engine web search",
    "tags" : [ "search", "web" ],
    "status" : "ACTIVE",
    "visibility_scope" : "ALL_TENANTS",
    "current_package_id" : "pkg-uuid-001",
    "current_version" : "1.0.0",
    "current_revision" : 1,
    "source" : "CUSTOM",
    "support_os_types" : [ "Windows", "Linux" ],
    "create_time" : "2026-05-12T10:00:00Z",
    "update_time" : "2026-05-12T10:00:00Z",
    "attach_instance_number" : 3
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Common Skills