创建插件账号连接¶
根据插件发布的连接要求创建账号连接,授权另行完成。
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-connections
调用前准备¶
准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。示例使用 jq 构造 JSON,运行前安装。环境变量的来源见公共对象与输入。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-connections" \
-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" --arg CONNECTION_REQUIREMENT "$CONNECTION_REQUIREMENT" --arg CONNECTION_PROFILE "$CONNECTION_PROFILE" '
{
"release_namespace": $RELEASE_NAMESPACE,
"release_id": $RELEASE_ID,
"requirement": $CONNECTION_REQUIREMENT,
"profile": $CONNECTION_PROFILE,
"name": "我的插件账号"
}
')"
示例使用 oauth 配置。创建只保存连接,不完成账号授权。managed_session 可按部署支持选择执行器;managed 别名由服务端解析为实际执行器,后续安装绑定使用连接回读的实际值。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
system 或 workspace。 |
|
string |
是 |
所选发布的 ID,来自发布列表。 |
|
string |
是 |
发布 connections.requirements 中的要求键。 |
|
string |
是 |
该要求 profiles 中的配置键。 |
|
string |
是 |
调用者提供的账号说明;返回的 name 由服务生成,此值保存在 description。 |
|
string |
条件必填 |
managed_session 配置要求执行器标识;其他驱动必须省略或为空。 |
JSON 对象不接受未知字段、重复键或多个连续对象;总请求体不超过 1 MiB。
成功响应¶
{
"code": 0,
"data": {
"id": "connection_example",
"workspace_id": "workspace_example",
"name": "provider · connection_example",
"description": "我的插件账号",
"status": "active",
"kind": "plugin",
"endpoint_uri": "https://service.example.invalid",
"auth_type": "oauth2",
"visibility": "private",
"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 |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
integer |
当前资源版本,写入时作为 expected_version。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
错误响应¶
业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。