获取技能信息

该 API 用于查询某个 Aily 应用的特定技能详情

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

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/aily/v1/apps/:app_id/skills/:skill_id
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 字符
skill_id	string	技能 ID；可通过技能编辑页面的浏览器地址栏获取（skill_xxx） 示例值："skill_6cc6166178ca" 数据校验规则： - 长度范围：0 ～ 32 字符

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ skill	skill	技能信息
└ id	string	技能 ID
└ label	string	技能名称
└ description	string	技能描述
└ samples	string\[\]	用户提问示例
└ input_schema	string	技能入参定义
└ output_schema	string	技能出参定义

响应体示例

{
  "code": 0,
  "data": {
    "skill": {
      "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": []
    }
  },
  "msg": ""
}

错误码

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