Workspaces
Manage workspaces and workspace memberships. The examples use A2A code mode. MCP exposes the same code mode through itsexecute tool.
Functions
workspaces.add
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | workspace.manage | Auth required | yes |
| Execution mode | sync | Capability | workspace.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/workspaces |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
name | str | yes | Workspace display name |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID that owns the workspace |
id | str | yes | Workspace UUID |
name | str | yes | Workspace display name |
created_at | str | null | no | Workspace creation timestamp |
status | str | no | Workspace lifecycle status |
updated_at | str | null | no | Workspace last update timestamp |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
workspaces.delete
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | workspace.manage | Auth required | yes |
| Execution mode | sync | Capability | workspace.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/workspaces/{workspace_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
workspace_id | str | yes | Workspace UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
workspaces.get
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | workspace.view | Auth required | yes |
| Execution mode | sync | Capability | workspace.view |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/workspaces/{workspace_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
workspace_id | str | yes | Workspace UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID that owns the workspace |
id | str | yes | Workspace UUID |
name | str | yes | Workspace display name |
created_at | str | null | no | Workspace creation timestamp |
status | str | no | Workspace lifecycle status |
updated_at | str | null | no | Workspace last update timestamp |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
workspaces.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | workspace.view | Auth required | yes |
| Execution mode | sync | Capability | workspace.view |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/workspaces |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
page | int | no | One-based workspace page number |
page_size | int | no | Maximum workspaces per page |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
items | [{"account_id": str, "id": str, "name": str, "created_at"?: str | null, "status"?: str, "updated_at"?: str | null}] | yes | Workspaces on this page |
page | int | yes | Current one-based page number |
page_size | int | yes | Maximum items per page |
total | int | yes | Total matching workspaces |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
workspaces.update
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | workspace.manage | Auth required | yes |
| Execution mode | sync | Capability | workspace.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | PATCH /v1/public/accounts/{account_id}/workspaces/{workspace_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
workspace_id | str | yes | Workspace UUID from the route path |
name | str | yes | Workspace display name |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID that owns the workspace |
id | str | yes | Workspace UUID |
name | str | yes | Workspace display name |
created_at | str | null | no | Workspace creation timestamp |
status | str | no | Workspace lifecycle status |
updated_at | str | null | no | Workspace last update timestamp |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response: