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

Querying Details About a Common Skill (Read-Only)

Function

An enterprise tenant queries details about a common skill (read-only).

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:getCommon

    Read

    -

    -

    -

    -

URI

GET /v3/ai-agents/common-skills/{skill_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

skill_id

Yes

String

Skill ID.

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

id

String

Skill ID.

slug

String

Skill slug.

display_name

String

Skill name.

alias_name

String

Alias.

description

String

Skill description.

category

String

Skill category.

tags

Array of strings

Skill tag.

owner_type

String

Skill owner type.

visibility_scope

String

Visibility scope.

visible_domain_ids

Array of strings

IDs of tenants in the visibility scope. This parameter is returned only when visibility_scope is set to SPECIFIC_TENANTS.

status

String

Skill status.

current_package_id

String

ID of the skill package that is currently in effect.

cover

String

Base64-encoded skill cover image.

source

String

Skill source.

support_os_types

Array of strings

List of supported OS types.

packages

Array of SkillPackageSummary objects

Skill package summary list.

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.
Table 5 SkillPackageSummary

Parameter

Type

Description

id

String

Skill package ID.

version

String

Version.

revision

Integer

Version revision number.

package_status

String

Skill package status.

regions

Array of strings

Deployed region IDs.

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: 404

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.

Status code: 500

Table 14 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 15 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/skill-uuid-001

Example Responses

Status code: 200

{
  "id" : "skill-uuid-001",
  "slug" : "web-search-v1",
  "display_name" : "Web Search",
  "alias_name" : "Web Search",
  "description" : "Multi-engine web search",
  "category" : "WEB_SEARCH",
  "tags" : [ "search", "web" ],
  "owner_type" : "COMMON",
  "visibility_scope" : "ALL_TENANTS",
  "status" : "ACTIVE",
  "current_package_id" : "pkg-uuid-001",
  "cover" : "data:image/png;base64,iVBOR...",
  "source" : "CUSTOM",
  "support_os_types" : [ "Windows", "Linux" ],
  "packages" : [ {
    "id" : "pkg-uuid-001",
    "version" : "1.0.0",
    "revision" : 1,
    "package_status" : "PUBLISHED",
    "regions" : [ "cn-north-7", "cn-south-1" ]
  } ],
  "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

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Common Skills