检查插件账号授权尝试¶
检查并推进同一插件账号的授权尝试。
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-connections/{connection_id}/oauth/{attempt_id}/poll
调用前准备¶
准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id、connection_id、attempt_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。示例使用 jq 构造 JSON,运行前安装。环境变量的来源见公共对象与输入。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-connections/$CONNECTION_ID/oauth/$ATTEMPT_ID/poll" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary "$(jq -n --argjson CONNECTION_VERSION "$CONNECTION_VERSION" '
{
"expected_version": $CONNECTION_VERSION
}
')"
设置 $ATTEMPT_ID 为已保存的非空尝试 ID。一次调用执行一次检查;pending/exchanging 时遵守 poll_after。终态后停止,授权是否可用再由授权状态判断。next_action 需要再次用户操作。版本改变、superseded 或过期时复核,不自动发起新授权。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
当前连接或安装的 version,必须大于 0。 |
JSON 对象不接受未知字段、重复键或多个连续对象;总请求体不超过 1 MiB。
成功响应¶
{
"code": 0,
"data": {
"attempt_id": "attempt_example",
"status": "pending",
"poll_after": 2
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
|
object |
当前动作返回的数据。 |
|
string |
授权尝试 ID;browser_handoff 为空。 |
|
string |
当前状态;按本页条件及公共对象判断。 |
|
integer |
资源字段,详见公共对象与状态。 |
错误响应¶
业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。
最后更新于