Skip to main content

查询技能接口

查询企业市场中的技能资源，按关键词、状态、来源和分类筛选。返回资源标识、展示信息和修订号，可用于定位需要维护的技能。

  • Scope：admin.v1.skills.read
  • 权限项：技能读取（skills）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/skills

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
statusquerystring否启用状态"draft"
originquerystring否归属"all"
category_idquerystring · uuid否分类（分类 ID）"<uuid>"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/skills?keyword=<keyword>&status=<status>&origin=all&category_id=<category_id>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是技能列表-
next_cursorstring否下一页游标"<string>"
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
total_pagesinteger · int64是总页数0
total_rowsinteger · int64是总条数0

items[] 字段

字段对应关系：name 是创建技能时填写的唯一标识，编辑接口不支持修改；name_cn、name_en 分别对应创建、编辑接口的中文名称和英文名称。编辑时将 id 作为路径参数 resourceId，将 revision 作为请求字段 expected_revision。
字段类型必填说明
clientsarray<string> ｜ null是适用客户端
created_atstring · date-time否创建时间
created_bystring否创建人 ID
created_by_emailstring否创建人邮箱
created_by_namestring否创建人姓名
descriptionstring是描述（英文）
description_cnstring否描述
has_packageboolean是是否已上传资源包
icon_urlstring否资源图标（URL）
idstring是技能 ID
namestring是唯一标识
name_cnstring否技能名称
name_enstring否技能名称（英文）
originstring是归属
revisioninteger · int64是版本号，用于并发更新校验
source_typestring否来源类型；可选值：official
statusstring是启用状态
updated_atstring · date-time否更新时间
updated_bystring否更新人 ID
updated_by_emailstring否更新人邮箱
updated_by_namestring否更新人姓名
versionstring否版本
{
  "items": [
    {
      "clients": [
        "<string>"
      ],
      "created_at": "2026-08-27T10:00:00Z",
      "created_by": "<string>",
      "created_by_email": "<string>",
      "created_by_name": "<string>",
      "description": "<string>",
      "description_cn": "<string>",
      "has_package": false,
      "icon_url": "<string>",
      "id": "<string>",
      "name": "<string>",
      "name_cn": "<string>",
      "name_en": "<string>",
      "origin": "<string>",
      "revision": 0,
      "source_type": "official",
      "status": "<string>",
      "updated_at": "2026-08-27T10:00:00Z",
      "updated_by": "<string>",
      "updated_by_email": "<string>",
      "updated_by_name": "<string>",
      "version": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "page": 0,
  "page_size": 0,
  "total_pages": 0,
  "total_rows": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}