Skip to main content

Workspace & folders

Functions for discovering the workspace tree and organizing it: listing folders and their contents, creating and renaming folders, opening objects in the editor, and moving objects between folders.

folder-list is the starting point for almost every Higento task — it returns the ids Higento needs to read, update, link, or move other objects.


folder-list

List folders in the organization with their contents. Returns each folder's id, name, parentId, and path (name trail), plus the agents, tools, knowledge bases, tables, and workflows it contains (each as id + display name). Optionally scope to a single folder subtree.

Input

FieldTypeRequiredDescription
folderIdstring | nullNoRoot folder id to scope results to (that folder + descendants). Omit or null for the full org tree.

Output

FieldTypeDescription
assistantFolderScopeIdstring | nullThe folder Higento is scoped to (if any).
assistantFolderScopeNamestringDisplay name of the scope folder.
rootFolderIdstring | nullThe requested scope root, or null for the whole org.
foldersarrayFolders in scope. Each: id, name, parentId, path, and arrays agents[], tools[], knowledgeBases[], tables[], workflows[] (each entry \{ id, name \}).

folder-create

Create a new folder. Placement: omit parentFolderId to use the assistant's folder scope (or org root if unscoped); pass null for org root explicitly; pass a folder id to nest inside it.

Input

FieldTypeRequiredDescription
namestringYesDisplay name for the new folder.
parentFolderIdstring | nullNoOmit = assistant scope/org root. null = org root. String = parent folder id.

Output

FieldTypeDescription
folderIdstringId of the created folder (dir_…).
parentIdstring | nullParent folder id, or null at org root.

folder-rename

Rename a folder. Does not move it. Respects assistant folder scope.

Input

FieldTypeRequiredDescription
folderIdstringYesId of the folder to rename.
newNamestringYesNew display name (min 1 char).

Output

FieldTypeDescription
folderobjectThe updated folder: \{ id, name, parentId \}.

workspace-navigate

Open an object in the workspace UI: the editor route for an agent, tool, workflow, table, or knowledge base, or the folder view for a folder. Does not navigate to schedules.

Input

FieldTypeRequiredDescription
kindenumYesOne of folder, agent, tool, workflow, table, knowledgeBase.
entityIdstringYesId of the object, matching kind (folder→dir_…, agent→agt_…, tool→tool_…, workflow→wrk_…, table→t_…, knowledgeBase→kb_…).

Output

FieldTypeDescription
kindstringThe object kind that was opened.
namestringDisplay name of the opened object.
entityIdstringResolved object id (for agents this is the resolved agent id).
pathAfterOrgstringRoute path after the org segment, used to navigate the UI.
folderIdForQuerystring | nullFolder context for the route.
pathstringFolder path trail (for kind: folder).

workspace-move

Move one object into a destination folder. The kind must match the object referenced by entityId; Higento also infers kind from the id prefix to guard against mistakes. Moving a folder into one of its own descendants is rejected (cycle).

Input

FieldTypeRequiredDescription
kindenumYesType of object being moved: agent, folder, tool, table, workflow.
entityIdstringYesId of the object being moved (matching kind).
targetFolderIdstring | nullYesDestination folder id (dir_…) or null for organization root.

Output

FieldTypeDescription
idstringId of the moved object.