Pular para o conteúdo principal

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.

​
Etiquetas

Gerenciar etiquetas de recursos e suas atribuições. Os exemplos usam o modo de código A2A. O MCP expõe o mesmo modo de código pela ferramenta execute.

​
Funções

​
tags.add

tags.add(account_id: str, tag_name: str, color_hex?: str, description?: str | null) -> Tag
Etiquetas: tags.add.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/tags
NomeTipoObrigatório
account_idstrsim
tag_namestrsim
color_hexstrnão
descriptionstr | nullnão
CampoTipoObrigatório
color_hexstrsim
idstrsim
namestrsim
created_atstr | nullnão
descriptionstr | nullnão
updated_atstr | nullnão
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_name=\"<string>\", color_hex=\"<string>\", description=\"<string>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.add",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_name=\"<string>\", color_hex=\"<string>\", description=\"<string>\")"
    }
  }
}
Resposta:
{
  "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\": \"tags.add\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
tags.delete

tags.delete(account_id: str, tag_id: str) -> {}
Etiquetas: tags.delete.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaDELETE /v1/public/accounts/{account_id}/tags/{tag_id}
NomeTipoObrigatório
account_idstrsim
tag_idstrsim
CampoTipoObrigatório
result{}sim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Resposta:
{
  "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\": \"tags.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
tags.domains.assign

tags.domains.assign(account_id: str, tag_id: str, domain_ids: [str]) -> Tag
Etiquetas: tags.domains.assign.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/assign
NomeTipoObrigatório
account_idstrsim
tag_idstrsim
domain_ids[str]sim
CampoTipoObrigatório
domain_ids[str]sim
tag_idstrsim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "domain_ids": [
        "<string>"
      ],
      "tag_id": "<string>"
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.domains.assign",
      "status": "completed",
      "result": {
        "domain_ids": [
          "<string>"
        ],
        "tag_id": "<string>"
      }
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
  }
}
Resposta:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"domain_ids\": [\n        \"<string>\"\n      ],\n      \"tag_id\": \"<string>\"\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.domains.assign\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"domain_ids\": [\n          \"<string>\"\n        ],\n        \"tag_id\": \"<string>\"\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
tags.domains.unassign

tags.domains.unassign(account_id: str, tag_id: str, domain_ids: [str]) -> {}
Etiquetas: tags.domains.unassign.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/unassign
NomeTipoObrigatório
account_idstrsim
tag_idstrsim
domain_ids[str]sim
CampoTipoObrigatório
result{}sim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.domains.unassign",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
  }
}
Resposta:
{
  "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\": \"tags.domains.unassign\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
tags.list

tags.list(account_id: str, page?: int, page_size?: int) -> Page[Tag]
Etiquetas: tags.list.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.viewAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.view
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaGET /v1/public/accounts/{account_id}/tags
NomeTipoObrigatório
account_idstrsim
pageintnão
page_sizeintnão
CampoTipoObrigatório
items[{"color_hex": str, "id": str, "name": str, "created_at"?: str | null, "description"?: str | null, "updated_at"?: str | null}]sim
pageintsim
page_sizeintsim
totalintsim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
Resposta:
{
  "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\": \"tags.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
tags.update

tags.update(account_id: str, tag_id: str, color_hex?: str | null, description?: str | null, tag_name?: str | null) -> Tag
Etiquetas: tags.update.
PropriedadeValorPropriedadeValor
Permissão necessáriatag.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidadetag.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPATCH /v1/public/accounts/{account_id}/tags/{tag_id}
NomeTipoObrigatório
account_idstrsim
tag_idstrsim
color_hexstr | nullnão
descriptionstr | nullnão
tag_namestr | nullnão
CampoTipoObrigatório
color_hexstrsim
idstrsim
namestrsim
created_atstr | nullnão
descriptionstr | nullnão
updated_atstr | nullnão
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", color_hex=\"<string>\", description=\"<string>\", tag_name=\"<string>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "tags.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", color_hex=\"<string>\", description=\"<string>\", tag_name=\"<string>\")"
    }
  }
}
Resposta:
{
  "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\": \"tags.update\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}