查询插件能力描述

读取搜索返回的插件能力说明与输入要求。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-discovery/describe

调用前准备

准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。环境变量的来源见公共对象与输入。

查询参数

curl -X GET "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-discovery/describe" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  --get \
  --data-urlencode "ref=$CAPABILITY_REF"

读取所选能力的输入 Schema、连接要求或技能路径。描述不执行能力,也不授予账号权限。版本冲突时重新搜索,不改写引用内的标识和摘要。

字段

类型

是否必填

说明

ref

string

是

搜索返回的 capability_ref,按原值进行 URL 编码。

成功响应

{
  "code": 0,
  "data": {
    "capability": {
      "id": "operation:example",
      "name": "example",
      "description": "示例能力",
      "kind": "http",
      "side_effect": "read",
      "digest": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "capability_ref": "opaque-example",
    "input_schema": {
      "type": "object"
    }
  }
}

字段

类型

说明

code

integer

成功时为 0。

data

object

当前动作返回的数据。

data.capability

object

资源字段,详见公共对象与状态。

data.capability_ref

string

资源字段,详见公共对象与状态。

data.input_schema

object

资源字段,详见公共对象与状态。

错误响应

业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。

最后更新于