> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 工作区

> 管理工作区和工作区成员关系。

# 工作区

管理工作区和工作区成员关系。

<script src="/locale-bridge.js" />

示例使用 A2A 代码模式。MCP 通过 `execute` 工具公开相同的代码模式。

## 函数

### `workspaces.add`

```text theme={null}
workspaces.add(account_id: str, name: str) -> Workspace
```

工作区: `workspaces.add`.

| 属性        | 值                                                  | 属性       | 值                  |
| --------- | -------------------------------------------------- | -------- | ------------------ |
| 所需权限      | `workspace.manage`                                 | 需要身份验证   | `是`                |
| 执行模式      | `sync`                                             | 能力       | `workspace.manage` |
| 资源类型      | `account`                                          | 资源 ID 字段 | `account_id`       |
| 公共 API 路由 | `POST /v1/public/accounts/{account_id}/workspaces` |          |                    |

<AccordionGroup>
  <Accordion title="参数">
    | 名称           | 类型    | 必需 |
    | ------------ | ----- | -- |
    | `account_id` | `str` | 是  |
    | `name`       | `str` | 是  |
  </Accordion>

  <Accordion title="返回值">
    | 字段           | 类型            | 必需 |
    | ------------ | ------------- | -- |
    | `account_id` | `str`         | 是  |
    | `id`         | `str`         | 是  |
    | `name`       | `str`         | 是  |
    | `created_at` | `str \| null` | 否  |
    | `status`     | `str`         | 否  |
    | `updated_at` | `str \| null` | 否  |
  </Accordion>

  <Accordion title="A2A 示例">
    请求:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "workspaces.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
    }
    ```

    响应:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "workspaces.add",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP 示例">
    请求:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "workspaces.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
        }
      }
    }
    ```

    响应:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"workspaces.add\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `workspaces.delete`

```text theme={null}
workspaces.delete(account_id: str, workspace_id: str) -> {}
```

工作区: `workspaces.delete`.

| 属性        | 值                                                                   | 属性       | 值                  |
| --------- | ------------------------------------------------------------------- | -------- | ------------------ |
| 所需权限      | `workspace.manage`                                                  | 需要身份验证   | `是`                |
| 执行模式      | `sync`                                                              | 能力       | `workspace.manage` |
| 资源类型      | `account`                                                           | 资源 ID 字段 | `account_id`       |
| 公共 API 路由 | `DELETE /v1/public/accounts/{account_id}/workspaces/{workspace_id}` |          |                    |

<AccordionGroup>
  <Accordion title="参数">
    | 名称             | 类型    | 必需 |
    | -------------- | ----- | -- |
    | `account_id`   | `str` | 是  |
    | `workspace_id` | `str` | 是  |
  </Accordion>

  <Accordion title="返回值">
    | 字段       | 类型   | 必需 |
    | -------- | ---- | -- |
    | `result` | `{}` | 是  |
  </Accordion>

  <Accordion title="A2A 示例">
    请求:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "workspaces.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
    ```

    响应:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": {}
      },
      "responses": [
        {
          "index": 0,
          "function": "workspaces.delete",
          "status": "completed",
          "result": {}
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP 示例">
    请求:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "workspaces.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
        }
      }
    }
    ```

    响应:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"workspaces.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `workspaces.get`

```text theme={null}
workspaces.get(account_id: str, workspace_id: str) -> Workspace
```

工作区: `workspaces.get`.

| 属性        | 值                                                                | 属性       | 值                |
| --------- | ---------------------------------------------------------------- | -------- | ---------------- |
| 所需权限      | `workspace.view`                                                 | 需要身份验证   | `是`              |
| 执行模式      | `sync`                                                           | 能力       | `workspace.view` |
| 资源类型      | `account`                                                        | 资源 ID 字段 | `account_id`     |
| 公共 API 路由 | `GET /v1/public/accounts/{account_id}/workspaces/{workspace_id}` |          |                  |

<AccordionGroup>
  <Accordion title="参数">
    | 名称             | 类型    | 必需 |
    | -------------- | ----- | -- |
    | `account_id`   | `str` | 是  |
    | `workspace_id` | `str` | 是  |
  </Accordion>

  <Accordion title="返回值">
    | 字段           | 类型            | 必需 |
    | ------------ | ------------- | -- |
    | `account_id` | `str`         | 是  |
    | `id`         | `str`         | 是  |
    | `name`       | `str`         | 是  |
    | `created_at` | `str \| null` | 否  |
    | `status`     | `str`         | 否  |
    | `updated_at` | `str \| null` | 否  |
  </Accordion>

  <Accordion title="A2A 示例">
    请求:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "workspaces.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
    ```

    响应:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "workspaces.get",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP 示例">
    请求:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "workspaces.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
        }
      }
    }
    ```

    响应:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"workspaces.get\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `workspaces.list`

```text theme={null}
workspaces.list(account_id: str, page?: int, page_size?: int) -> Page[Workspace]
```

工作区: `workspaces.list`.

| 属性        | 值                                                 | 属性       | 值                |
| --------- | ------------------------------------------------- | -------- | ---------------- |
| 所需权限      | `workspace.view`                                  | 需要身份验证   | `是`              |
| 执行模式      | `sync`                                            | 能力       | `workspace.view` |
| 资源类型      | `account`                                         | 资源 ID 字段 | `account_id`     |
| 公共 API 路由 | `GET /v1/public/accounts/{account_id}/workspaces` |          |                  |

<AccordionGroup>
  <Accordion title="参数">
    | 名称           | 类型    | 必需 |
    | ------------ | ----- | -- |
    | `account_id` | `str` | 是  |
    | `page`       | `int` | 否  |
    | `page_size`  | `int` | 否  |
  </Accordion>

  <Accordion title="返回值">
    | 字段          | 类型                                                                                                                      | 必需 |
    | ----------- | ----------------------------------------------------------------------------------------------------------------------- | -- |
    | `items`     | `[{"account_id": str, "id": str, "name": str, "created_at"?: str \| null, "status"?: str, "updated_at"?: str \| null}]` | 是  |
    | `page`      | `int`                                                                                                                   | 是  |
    | `page_size` | `int`                                                                                                                   | 是  |
    | `total`     | `int`                                                                                                                   | 是  |
  </Accordion>

  <Accordion title="A2A 示例">
    请求:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "workspaces.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
    ```

    响应:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "workspaces.list",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP 示例">
    请求:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "workspaces.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
        }
      }
    }
    ```

    响应:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"workspaces.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `workspaces.update`

```text theme={null}
workspaces.update(account_id: str, workspace_id: str, name: str) -> Workspace
```

工作区: `workspaces.update`.

| 属性        | 值                                                                  | 属性       | 值                  |
| --------- | ------------------------------------------------------------------ | -------- | ------------------ |
| 所需权限      | `workspace.manage`                                                 | 需要身份验证   | `是`                |
| 执行模式      | `sync`                                                             | 能力       | `workspace.manage` |
| 资源类型      | `account`                                                          | 资源 ID 字段 | `account_id`       |
| 公共 API 路由 | `PATCH /v1/public/accounts/{account_id}/workspaces/{workspace_id}` |          |                    |

<AccordionGroup>
  <Accordion title="参数">
    | 名称             | 类型    | 必需 |
    | -------------- | ----- | -- |
    | `account_id`   | `str` | 是  |
    | `workspace_id` | `str` | 是  |
    | `name`         | `str` | 是  |
  </Accordion>

  <Accordion title="返回值">
    | 字段           | 类型            | 必需 |
    | ------------ | ------------- | -- |
    | `account_id` | `str`         | 是  |
    | `id`         | `str`         | 是  |
    | `name`       | `str`         | 是  |
    | `created_at` | `str \| null` | 否  |
    | `status`     | `str`         | 否  |
    | `updated_at` | `str \| null` | 否  |
  </Accordion>

  <Accordion title="A2A 示例">
    请求:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "workspaces.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
    }
    ```

    响应:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "workspaces.update",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP 示例">
    请求:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "workspaces.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
        }
      }
    }
    ```

    响应:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"workspaces.update\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>