查询技能列表¶
列出当前工作区技能和可读取的系统默认技能。系统技能的 workspace_id 为 system,应视为只读资源。
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/skills
调用前准备¶
准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
请求参数¶
curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/skills?status=active&limit=20&offset=0" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
路径参数
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
当前工作区 ID。 |
查询参数
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
按状态、来源类型、分类或阶段筛选。 |
|
string |
否 |
按状态、来源类型、分类或阶段筛选。 |
|
string |
否 |
按状态、来源类型、分类或阶段筛选。 |
|
string |
否 |
按状态、来源类型、分类或阶段筛选。 |
|
string |
否 |
按技能文本搜索。 |
|
string |
否 |
标签筛选值。可重复传入,例如 |
|
integer |
否 |
每页数量。默认 |
|
integer |
否 |
起始偏移量;负数按 |
成功响应¶
{
"code": 0,
"data": {
"items": [
{
"id": "skill_01",
"workspace_id": "ws_01",
"name": "摘要技能",
"description": "总结输入内容。",
"status": "active",
"source_type": "custom",
"version": 2
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}
成功时返回 200。
响应字段如下。
本文中,字段路径中的 [] 表示数组中的每一项。例如,items[].name 表示 items 数组中每一项的 name 字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 |
字段 |
类型 |
说明 |
|---|---|---|
|
array |
当前页的技能定义。 |
|
integer |
匹配技能总数。 |
|
integer |
本页请求的最大技能数。 |
|
integer |
本页第一条技能的零基偏移量。 |
下面表格展开响应示例中的 items 数据;每一行是该对象或数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
技能 ID。 |
|
string |
技能所属工作区;系统技能为 |
|
string |
名称、状态和来源类型。 |
|
string |
面向界面展示的名称;有值时返回。 |
|
string |
面向界面展示的说明;有值时返回。 |
|
array of string |
面向界面展示的标签;有值时返回。 |
|
string |
名称、状态和来源类型。 |
|
string |
名称、状态和来源类型。 |
|
string |
技能说明;未设置时不返回。 |
|
string |
来源引用;未设置时不返回。 |
|
string |
技能分类;未设置时不返回。 |
|
array of string |
技能标签;未设置时不返回。 |
|
string |
技能阶段;未设置时不返回。 |
|
object |
路由摘要;未设置时不返回。 |
|
object |
技能指令。 |
|
object |
技能依赖要求;未设置时不返回。 |
|
integer |
当前版本。 |
|
object |
扩展元数据;未设置时不返回。 |
|
string |
创建者标识;未设置时不返回。 |
|
string |
最近更新者标识;未设置时不返回。 |
|
string |
创建时间,采用 RFC 3339 格式。 |
|
string |
最近更新时间,采用 RFC 3339 格式。 |
错误响应¶
{
"code": 2,
"message": "<错误信息>"
}
常见 HTTP 错误
字段 |
类型 |
说明 |
|---|---|---|
|
|
**常见原因:**工作区或筛选参数无效。**建议操作:**检查路径和查询参数。 |
|
|
**常见原因:**缺少有效身份凭据。**建议操作:**检查 API Key。 |
|
|
**常见原因:**当前身份没有读取工作区技能的权限。**建议操作:**检查工作区授权。 |
|
|
**常见原因:**技能服务或授权依赖暂不可用。**建议操作:**稍后重试。 |
后续操作¶
保存目标技能的标识,再查询技能详情。