Naar hoofdinhoud gaan

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.

Tags

Resourcetags en tagtoewijzingen beheren. De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddel execute.

Functies

tags.add

tags.add(account_id: str, tag_name: str, color_hex?: str, description?: str | null) -> Tag
Tags: tags.add.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/tags
NaamTypeVereist
account_idstrja
tag_namestrja
color_hexstrnee
descriptionstr | nullnee
VeldTypeVereist
color_hexstrja
idstrja
namestrja
created_atstr | nullnee
descriptionstr | nullnee
updated_atstr | nullnee
Aanvraag:
{
  "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>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.add",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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) -> {}
Tags: tags.delete.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeDELETE /v1/public/accounts/{account_id}/tags/{tag_id}
NaamTypeVereist
account_idstrja
tag_idstrja
VeldTypeVereist
result{}ja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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
Tags: tags.domains.assign.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/assign
NaamTypeVereist
account_idstrja
tag_idstrja
domain_ids[str]ja
VeldTypeVereist
domain_ids[str]ja
tag_idstrja
Aanvraag:
{
  "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\")"
}
Respons:
{
  "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
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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]) -> {}
Tags: tags.domains.unassign.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/unassign
NaamTypeVereist
account_idstrja
tag_idstrja
domain_ids[str]ja
VeldTypeVereist
result{}ja
Aanvraag:
{
  "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\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.domains.unassign",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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]
Tags: tags.list.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/tags
NaamTypeVereist
account_idstrja
pageintnee
page_sizeintnee
VeldTypeVereist
items[{"color_hex": str, "id": str, "name": str, "created_at"?: str | null, "description"?: str | null, "updated_at"?: str | null}]ja
pageintja
page_sizeintja
totalintja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "tags.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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)"
    }
  }
}
Respons:
{
  "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
Tags: tags.update.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingtag.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidtag.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePATCH /v1/public/accounts/{account_id}/tags/{tag_id}
NaamTypeVereist
account_idstrja
tag_idstrja
color_hexstr | nullnee
descriptionstr | nullnee
tag_namestr | nullnee
VeldTypeVereist
color_hexstrja
idstrja
namestrja
created_atstr | nullnee
descriptionstr | nullnee
updated_atstr | nullnee
Aanvraag:
{
  "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>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "tags.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
  }
}