Skip to main content

Functions

Higento's capabilities are exposed as functions (internally called tools). Each function does one focused thing and is named object-verb, so agent-create creates an agent and table-read-rows reads rows from a table.

This section documents every function, grouped by the object it acts on. Each object page describes its functions with a standardized layout:

  • Purpose — what the function does and when Higento reaches for it.
  • Input — the arguments Higento passes (field, type, required, description).
  • Output — the structured result that comes back.

Shared contract

Every function returns an object that always contains:

FieldTypeDescription
successbooleanWhether the call succeeded.
messagestringHuman-readable summary (shown in chat, also used to explain failures).

On success, additional fields specific to the function are included (ids, payloads, pagination, …). On failure, success is false and message explains why. The per-function Output tables below list the success fields only.

Functions by object

ObjectFunctionsReference
Workspace & foldersfolder-list, folder-create, folder-rename, workspace-navigate, workspace-moveWorkspace & folders
Dashboardsdashboard-read, dashboard-enable, dashboard-add-widget, dashboard-update-widgetDashboards
Agentsagent-create, agent-ask-create, agent-read, agent-update, agent-run, agent-link-tool, agent-unlink-tool, agent-link-integration, agent-unlink-integration, agent-link, agent-unlinkAgents
Chatbotschatbot-create, chatbot-read, chatbot-updateChatbots
Toolstool-create, tool-read, tool-update, tool-update-interfaceTools
Tablestable-create, table-read, table-read-rows, table-read-row, table-row-create, table-row-update, table-view-create, table-update-interface, table-value-countsTables
Workflowsworkflow-create, workflow-readWorkflows
Integrationsintegration-connectIntegrations
Schedulesschedule-create, schedule-list, schedule-updateSchedules
Conversationask-userConversation

Conventions used in the reference

  • Id prefixes identify object types: folders dir_…, agents/chatbots agt_…, tools tool_…, tables t_…, workflows wrk_…, knowledge bases kb_…, schedules and tool versions have their own ids returned by the relevant functions.
  • Folder scope — when Higento is opened inside a folder, read/write functions only resolve objects in that folder subtree. Org-wide chats can reach the whole organization.
  • Discover before acting — most flows start with folder-list to obtain the ids of the objects to read, update, link, or move.
  • JSON Schema interfaces — tools and tables describe their data shape with JSON Schema. The inwards/outwards/artifact interfaces on a tool define its input and output contracts.