查询技能分类的名称、排序值和修订号。分类标识可用于筛选技能列表或为资源指定分类。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 技能读取(读取) | skills | admin.v1.skills.read | qwenwork-biz-service |
GET /api/openapi/v1/skill-categories
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| keyword | query | string | 否 | 用于筛选此列表的搜索关键词。 | "<string>" |
| 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/skill-categories?keyword=<keyword>&page=1&page_size=20' --header 'Authorization: Bearer <API_KEY>'
响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| items | array<OpenapifacadeCategoryResponse> | 是 | 符合查询条件的当前页记录列表。 | [{"category_id":"<uuid>","name":"<string>","order":0,"revision":1}] |
| items[].category_id | string · uuid | 是 | 资源所属分类的标识。 | "<uuid>" |
| items[].name | string | 是 | 资源分类的名称。 | "<string>" |
| items[].order | integer · int64 | 是 | 对象在列表中的排序值。 | 0 |
| items[].revision | integer · int64 | 是 | 当前记录的修订号,后续更新时用于校验并发修改。 最小值:1。 | 1 |
| page | integer · int64 | 是 | 当前结果页的页码,从 1 开始。 | 0 |
| page_size | integer · int64 | 是 | 每页返回的记录数。 | 0 |
| total | integer · int64 | 是 | 符合查询条件的记录总数。 | 0 |
{
"items": [
{
"category_id": "<uuid>",
"name": "<string>",
"order": 0,
"revision": 1
}
],
"page": 0,
"page_size": 0,
"total": 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>"
}