# 认领工作区

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

将当前身份已经具备成员关系的工作区认领到当前身份，并返回本次是否实际完成认领。此接口不会创建工作区，也不会授予成员关系。

```text
POST https://moi.matrixorigin.cn/newmoi/workspaces/claim
```

## 调用前准备

先确认当前身份已是目标工作区的成员。准备[个人访问令牌](../../../../guides/genesis/api-keys.md#创建和管理个人访问令牌)和目标工作区 ID。此接口不需要先进入某个工作区。认领对象只能是当前调用身份，不能指定其他用户。

## 请求体

将 `$AI_STUDIO_API_KEY` 和 `$WORKSPACE_ID` 替换为实际值。

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
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"'"
  }'
```

:::::
:::::{tab-item} 参数说明

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 要认领的工作区 ID。 |

:::::
::::::
:::::::

## 成功响应

成功时返回 200。用 `data.claimed` 和 `data.already_claimed` 判断本次是否实际认领。

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workspace_id": "ws_01",
    "claimed": true,
    "already_claimed": false
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.workspace_id` | string | 被认领的工作区 ID。 |
| `data.claimed` | boolean | 本次请求是否完成认领。 |
| `data.already_claimed` | boolean | 请求前该工作区是否已由当前身份认领。 |

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "ErrWorkspaceNotFound",
  "msg": "工作区不存在",
  "data": null
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 错误代码。 |
| `msg` | string | 可读错误信息。 |
| `data` | null | 错误响应中为 `null`。 |

:::::
::::::
:::::::

## 后续操作

用[查看工作区列表](list-workspaces.md#查询参数)确认目标工作区可访问。