安装插件¶
保存插件安装和所选账号连接绑定。
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-installations
调用前准备¶
准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。示例使用 jq 构造 JSON,运行前安装。环境变量的来源见公共对象与输入。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-installations" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary "$(jq -n --arg RELEASE_NAMESPACE "$RELEASE_NAMESPACE" --arg RELEASE_ID "$RELEASE_ID" --slurpfile PLUGIN_BINDINGS_FILE "$PLUGIN_BINDINGS_FILE" '
{
"release_namespace": $RELEASE_NAMESPACE,
"release_id": $RELEASE_ID,
"bindings": $PLUGIN_BINDINGS_FILE[0]
}
')"
安装保存和账号授权分别确认。绑定连接须属于当前用户、同一工作区,处于 active 状态并匹配发布配置。安装成功不代表所有组件已获授权或已可执行。 示例从 $PLUGIN_BINDINGS_FILE 读取完整绑定 JSON 对象。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
system 或 workspace。 |
|
string |
是 |
所选发布的 ID,来自发布列表。 |
|
object |
否 |
按连接要求键提供完整绑定集合;省略或空对象得到空集合。 |
|
string |
是 |
当前用户在同一工作区的插件连接 ID。 |
|
string |
是 |
该要求下的授权配置键。 |
|
string |
条件必填 |
managed_session 配置填写与连接一致的执行器 ID;其他驱动不提交。 |
|
string |
否 |
已有插件配置交互的操作 ID;普通安装可省略,不自行构造。 |
JSON 对象不接受未知字段、重复键或多个连续对象;总请求体不超过 1 MiB。
成功响应¶
{
"code": 0,
"data": {
"id": "installation_example",
"workspace_id": "workspace_example",
"release_workspace_id": "workspace_example",
"release_id": "pr_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"release_digest": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"release_name": "example",
"owner_user_id": "user_example",
"bindings": {},
"version": 1,
"created_at": "2026-11-11T00:00:00Z",
"updated_at": "2026-11-11T00:00:00Z"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
|
object |
当前动作返回的数据。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
object |
完整安装绑定集合。 |
|
integer |
当前资源版本,写入时作为 expected_version。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
错误响应¶
业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。