Skip to main content

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.

Workspaces

Manage workspaces and workspace memberships. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

Functions

workspaces.add

workspaces.add(account_id: str, name: str) -> Workspace
Create workspaces.
PropertyValuePropertyValue
Requires permissionworkspace.manageAuth requiredyes
Execution modesyncCapabilityworkspace.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/workspaces
NameTypeRequiredDescription
account_idstryesAccount UUID
namestryesWorkspace display name
FieldTypeRequiredDescription
account_idstryesAccount UUID that owns the workspace
idstryesWorkspace UUID
namestryesWorkspace display name
created_atstr | nullnoWorkspace creation timestamp
statusstrnoWorkspace lifecycle status
updated_atstr | nullnoWorkspace last update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "workspaces.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "workspaces.add",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
  }
}

workspaces.delete

workspaces.delete(account_id: str, workspace_id: str) -> {}
Delete workspaces.
PropertyValuePropertyValue
Requires permissionworkspace.manageAuth requiredyes
Execution modesyncCapabilityworkspace.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/workspaces/{workspace_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
workspace_idstryesWorkspace UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "workspaces.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "workspaces.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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\")"
    }
  }
}
Response:
{
  "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
  }
}

workspaces.get

workspaces.get(account_id: str, workspace_id: str) -> Workspace
Get workspaces.
PropertyValuePropertyValue
Requires permissionworkspace.viewAuth requiredyes
Execution modesyncCapabilityworkspace.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/workspaces/{workspace_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
workspace_idstryesWorkspace UUID from the route path
FieldTypeRequiredDescription
account_idstryesAccount UUID that owns the workspace
idstryesWorkspace UUID
namestryesWorkspace display name
created_atstr | nullnoWorkspace creation timestamp
statusstrnoWorkspace lifecycle status
updated_atstr | nullnoWorkspace last update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "workspaces.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "workspaces.get",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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\")"
    }
  }
}
Response:
{
  "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
  }
}

workspaces.list

workspaces.list(account_id: str, page?: int, page_size?: int) -> Page[Workspace]
List workspaces.
PropertyValuePropertyValue
Requires permissionworkspace.viewAuth requiredyes
Execution modesyncCapabilityworkspace.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/workspaces
NameTypeRequiredDescription
account_idstryesAccount UUID
pageintnoOne-based workspace page number
page_sizeintnoMaximum workspaces per page
FieldTypeRequiredDescription
items[{"account_id": str, "id": str, "name": str, "created_at"?: str | null, "status"?: str, "updated_at"?: str | null}]yesWorkspaces on this page
pageintyesCurrent one-based page number
page_sizeintyesMaximum items per page
totalintyesTotal matching workspaces
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "workspaces.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "workspaces.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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)"
    }
  }
}
Response:
{
  "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
  }
}

workspaces.update

workspaces.update(account_id: str, workspace_id: str, name: str) -> Workspace
Update workspaces.
PropertyValuePropertyValue
Requires permissionworkspace.manageAuth requiredyes
Execution modesyncCapabilityworkspace.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/workspaces/{workspace_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
workspace_idstryesWorkspace UUID from the route path
namestryesWorkspace display name
FieldTypeRequiredDescription
account_idstryesAccount UUID that owns the workspace
idstryesWorkspace UUID
namestryesWorkspace display name
created_atstr | nullnoWorkspace creation timestamp
statusstrnoWorkspace lifecycle status
updated_atstr | nullnoWorkspace last update timestamp
Request:
{
  "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>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "workspaces.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
  }
}