查询技能列表

该 API 用于查询某个 Aily 应用的技能列表

包括内置的数据分析与问答技能、以及未在对话开启的技能。

Tip: 更多信息及示例代码，可参考 Aily 技能 OpenAPI 接口说明。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/aily/v1/apps/:app_id/skills
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	aily:skill:read 获取技能信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
app_id	string	Aily 应用 ID（spring_xxx__c），可以在 Aily 应用开发页面的浏览器地址里获取 示例值："spring_e7004f87f1__c" 数据校验规则： - 长度范围：0 ～ 64 字符

查询参数

名称	类型	必填	描述
page_size	int	否	本次请求获取的消息记录条数，默认 20 示例值：10
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ skills	skill\[\]	技能列表
└ id	string	技能 ID
└ label	string	技能名称
└ description	string	技能描述
└ samples	string\[\]	用户提问示例
└ input_schema	string	技能入参定义
└ output_schema	string	技能出参定义
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
  "code": 0,
  "data": {
    "has_more": false,
    "page_token": "skill_cb6685a0ef33",
    "skills": [
      {
        "description": "工作流技能",
        "id": "skill_8c71459001b2",
        "input_schema": "[{\"name\":\"userInput\",\"type\":\"String\",\"required\":true,\"defaultValue\":\"你好\",\"description\":\"\"},{\"name\":\"chatHistory\",\"type\":\"List\",\"required\":true,\"defaultValue\":null,\"description\":\"\"},{\"name\":\"userMessage\",\"type\":\"__SpringUserMessage\",\"required\":false,\"defaultValue\":null,\"description\":\"\"}]",
        "label": "工作流技能",
        "output_schema": "[{\"name\":\"message_status\",\"type\":\"Boolean\",\"required\":false,\"defaultValue\":null,\"description\":\"\"},{\"name\":\"input_message\",\"type\":\"String\",\"required\":false,\"defaultValue\":null,\"description\":\"\"}]",
        "samples": []
      },
      {
        "description": "理解用户提出的问题，对当前助手已经配置的数据资产进行知识搜索、数据分析、文档阅读，总结并返回答案。",
        "id": "skill_cb6685a0ef33",
        "input_schema": "",
        "label": "数据分析和问答",
        "output_schema": "",
        "samples": []
      }
    ]
  },
  "msg": ""
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2700001	param is invalid	参数错误