认领工作区¶
将当前身份已经具备成员关系的工作区认领到当前身份,并返回本次是否实际完成认领。此接口不会创建工作区,也不会授予成员关系。
POST https://moi.matrixorigin.cn/newmoi/workspaces/claim
调用前准备¶
先确认当前身份已是目标工作区的成员。准备个人访问令牌和目标工作区 ID。此接口不需要先进入某个工作区。认领对象只能是当前调用身份,不能指定其他用户。
请求体¶
将 $AI_STUDIO_API_KEY 和 $WORKSPACE_ID 替换为实际值。
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/claim" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"workspace_id": "'"$WORKSPACE_ID"'"
}'
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要认领的工作区 ID。 |
成功响应¶
成功时返回 200。用 data.claimed 和 data.already_claimed 判断本次是否实际认领。
{
"code": "OK",
"msg": "OK",
"data": {
"workspace_id": "ws_01",
"claimed": true,
"already_claimed": false
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
string |
被认领的工作区 ID。 |
|
boolean |
本次请求是否完成认领。 |
|
boolean |
请求前该工作区是否已由当前身份认领。 |
错误响应¶
{
"code": "ErrWorkspaceNotFound",
"msg": "工作区不存在",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
用查看工作区列表确认目标工作区可访问。
最后更新于