查询企业市场中的技能资源,按关键词、状态、来源和分类筛选。返回资源标识、展示信息和修订号,可用于定位需要维护的技能。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 技能读取(读取) | skills | admin.v1.skills.read | qwenwork-biz-service |
GET /api/openapi/v1/skills
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| keyword | query | string | 否 | 用于筛选此列表的搜索关键词。 | "<string>" |
| status | query | string | 否 | 只返回此状态的记录;不填写时不按状态筛选。 | "draft" |
| origin | query | string | 否 | 资源来源筛选条件;默认 all,查询全部来源。 默认值:"all"。 | "all" |
| category_id | query | string · uuid | 否 | 只查询此分类下的资源,填写分类列表返回的标识。 | "<uuid>" |
| page | query | integer · int64 | 否 | 请求的页码,从 1 开始。 默认值:1。 最小值:1。 | 1 |
| page_size | query | integer · int64 | 否 | 每页返回的记录数量。 默认值:20。 最小值:1。 最大值:100。 | 20 |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request GET --url '<BASE_URL>/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 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| items | array | null | 是 | 符合查询条件的当前页记录列表。 | [{"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>"}] |
| items[].clients | array | null | 是 | 可使用此资源的客户端类型列表。 | ["<string>"] |
| items[].created_at | string · date-time | 否 | 此记录的创建时间。 | "2026-08-27T10:00:00Z" |
| items[].created_by | string | 否 | 创建者的用户标识。 | "<string>" |
| items[].created_by_email | string | 否 | 创建者的邮箱。 | "<string>" |
| items[].created_by_name | string | 否 | 创建者的姓名。 | "<string>" |
| items[].description | string | 是 | 此对象的说明,用于补充名称之外的信息。 | "<string>" |
| items[].description_cn | string | 否 | 资源的中文说明。 | "<string>" |
| items[].has_package | boolean | 是 | 该资源是否包含可用的资源包。 | false |
| items[].icon_url | string | 否 | 资源图标的访问地址。 | "<string>" |
| items[].id | string | 是 | 此记录的唯一标识,查询、更新或删除对应记录时使用。 | "<string>" |
| items[].name | string | 是 | 用于识别此对象的名称。 | "<string>" |
| items[].name_cn | string | 否 | 资源的中文名称。 | "<string>" |
| items[].name_en | string | 否 | 资源的英文名称。 | "<string>" |
| items[].origin | string | 是 | 资源的来源类型,用于区分资源归属。 | "<string>" |
| items[].revision | integer · int64 | 是 | 当前记录的修订号,后续更新时用于校验并发修改。 | 0 |
| items[].source_type | string | 否 | 资源来源的具体类型。 可选值:official。 | "official" |
| items[].status | string | 是 | 此记录当前所处的状态。 | "<string>" |
| items[].updated_at | string · date-time | 否 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
| items[].updated_by | string | 否 | 最后修改者的用户标识。 | "<string>" |
| items[].updated_by_email | string | 否 | 最后修改者的邮箱。 | "<string>" |
| items[].updated_by_name | string | 否 | 最后修改者的姓名。 | "<string>" |
| items[].version | string | 否 | 资源包的版本标识。 | "<string>" |
| next_cursor | string | 否 | 继续读取下一批结果时使用的游标;没有后续结果时为空。 | "<string>" |
| page | integer · int64 | 是 | 当前结果页的页码,从 1 开始。 | 0 |
| page_size | integer · int64 | 是 | 每页返回的记录数。 | 0 |
| total_pages | integer · int64 | 是 | 按当前每页数量计算的总页数。 | 0 |
| total_rows | integer · int64 | 是 | 符合查询条件的记录总数。 | 0 |
{
"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 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}