> ## 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>
