Skip to main content

Structure and tasks

Workspaces, activities and tasks — the tree that organizes what the agent does —, running a task, the pre-check and the HTTP trigger endpoint.

Families on this page​

FamilyToolsreadwritedestructive
workspaces — Workspaces5221
activities — Activities5221
tasks — Tasks10424

workspaces​

ToolKindScopePermissionEndpointWhat it does
kadu_workspaces_listreadkadu/workspaces + readagent.workspaces.listGET /v1/workspacesLists the workspaces of the organization (the top level of Workspace > Activity > Task).
kadu_workspaces_getreadkadu/workspaces + readagent.workspaces.readGET /v1/workspaces/{id}Gets a workspace.
kadu_workspaces_createwritekadu/workspaces + writeagent.workspaces.createPOST /v1/workspacesCreates a workspace.
kadu_workspaces_updatewritekadu/workspaces + writeagent.workspaces.updatePATCH /v1/workspaces/{id}Updates a workspace.
kadu_workspaces_deletedestructivekadu/workspaces + deleteagent.workspaces.deleteDELETE /v1/workspaces/{id}Deletes a workspace together with its activities and tasks.

activities​

ToolKindScopePermissionEndpointWhat it does
kadu_activities_listreadkadu/activities + readagent.activities.listGET /v1/activitiesLists the activities (groups of tasks inside a workspace).
kadu_activities_getreadkadu/activities + readagent.activities.readGET /v1/activities/{id}Gets an activity.
kadu_activities_createwritekadu/activities + writeagent.activities.createPOST /v1/activitiesCreates an activity inside a workspace.
kadu_activities_updatewritekadu/activities + writeagent.activities.updatePATCH /v1/activities/{id}Updates an activity.
kadu_activities_deletedestructivekadu/activities + deleteagent.activities.deleteDELETE /v1/activities/{id}Deletes an activity together with its tasks.

tasks​

ToolKindScopePermissionEndpointWhat it does
kadu_tasks_listreadkadu/tasks + readagent.tasks.listGET /v1/tasksLists the tasks: each one runs a skill (<plugin>:<skill>) of the organization repository as the agent.
kadu_tasks_getreadkadu/tasks + readagent.tasks.readGET /v1/tasks/{id}Gets a task, with its parameters schema and whether it is conversational.
kadu_tasks_createwritekadu/tasks + writeagent.tasks.createPOST /v1/tasksCreates a task that runs a skill of the organization repository.
kadu_tasks_updatewritekadu/tasks + writeagent.tasks.updatePATCH /v1/tasks/{id}Updates a task.
kadu_tasks_deletedestructivekadu/tasks + deleteagent.tasks.deleteDELETE /v1/tasks/{id}Deletes a task.
kadu_tasks_rundestructivekadu/tasks + writeagent.executions.runPOST /v1/tasks/{id}/runRuns a task: queues an execution of the financial agent in an environment.
kadu_tasks_readiness_getreadkadu/tasks + readagent.tasks.readGET /v1/tasks/{id}/readinessPre-check of a run: whether the task can be run now in the environment (plan, cost limit, missing secrets, repository).
kadu_tasks_endpoint_getreadkadu/tasks + readagent.tasks.readGET /v1/tasks/{id}/endpointGets the task's HTTP trigger endpoint: URL, whether it is enabled and the auth type (credentials are never returned).
kadu_tasks_endpoint_updatedestructivekadu/tasks + writeagent.tasks.updatePUT /v1/tasks/{id}/endpointConfigures the HTTP endpoint that lets a third party trigger the task, with its credentials.
kadu_tasks_endpoint_deletedestructivekadu/tasks + deleteagent.tasks.updateDELETE /v1/tasks/{id}/endpointDisables the task's HTTP trigger endpoint (the configuration is kept).

The fields of each resource are in the API reference.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.