Help Center/ Workspace/ API Reference/ Workspace APIs/ Skill Binding/ Listing Skills Bound to an Instance
Updated on 2026-09-11 GMT+08:00
View PDF
Share

Listing Skills Bound to an Instance

Function

This API is used to list the skills bound to an instance.

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:agentInstance:listSkills

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/instances/{instance_id}/skills

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.
Table 2 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.

Request Parameters

Table 3 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 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 5 Response body parameters

Parameter

Type

Description

total

Integer

Total quantity.

items

Array of InstanceSkillItemVO objects

List of skills bound to the instance.
Table 6 InstanceSkillItemVO

Parameter

Type

Description

skill_id

String

Skill ID.

display_name

String

Skill name.

slug

String

Skill slug.

alias_name

String

Alias.

description

String

Skill description.

owner_type

String

Skill owner type.

install_status

String

Installation status.

package_id

String

ID of the installed skill package.

version

String

Version of the installed skill package.

installed_at

String

Installation time (UTC time in ISO 8601 format).

cover

String

Base64-encoded skill cover image.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 8 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 9 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 10 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 11 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 12 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 13 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 14 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 15 Response header parameters

Parameter

Type

Description

X-Request-Id

String

-
Table 16 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/instances/instance-001/skills?offset=0&limit=20

Example Responses

Status code: 200

{
  "items" : [ {
    "skill_id" : "skill-uuid-001",
    "display_name" : "Web Search",
    "slug" : "web-search-v1",
    "alias_name" : "Web Search",
    "description" : "Web search for real-time information",
    "owner_type" : "COMMON",
    "install_status" : "INSTALLED",
    "package_id" : "pkg-uuid-001",
    "version" : "1.0.0",
    "installed_at" : "2026-05-12T10:30:00Z",
    "cover" : "data:image/png;base64,iVBOR..."
  }, {
    "skill_id" : "skill-uuid-002",
    "display_name" : "Doc Helper",
    "slug" : "internal-doc-helper",
    "alias_name" : "Doc Helper",
    "description" : "Enterprise internal document processing skill",
    "owner_type" : "TENANT",
    "install_status" : "INSTALLED",
    "package_id" : "pkg-uuid-010",
    "version" : "1.0.0",
    "installed_at" : "2026-05-13T08:30:00Z",
    "cover" : "data:image/png;base64,iVBOR..."
  } ]
}

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: Skill Binding