Skip to content
SHAMPOO

Tool catalogue

get_task_links

Read · Ordinary · Links

  • Category: links
  • Access: read
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Lists every live knowledge-graph entity linked to one task. The read side of the manual linking workflow.

Arguments

Required: task_id.

  • task_id.

Result

JSON object with task_id and links, each carrying entity_id, entity_name, entity_type, link_type, score (or null), and created_at (or null).

Boundaries

The task and the linked entities must all be visible under the caller's project grants. An invisible task reads as an empty link list, never a denial; a malformed id answers Task not found.

Lifecycle / side effects

Pure read over live links and live entities; removed links and retired entities resolve as absent.

Errors

Missing or non-string task_id is rejected by validation. Unknown arguments are rejected (strict validator).

Example

{
  "task_id": "<uuid>"
}

Result shape:

{
  "links": [
    {
      "created_at": "<iso-8601>",
      "entity_name": "Acme Print",
      "entity_type": "vendor",
      "link_type": "manual",
      "score": null
    }
  ],
  "task_id": "<uuid>"
}

See also

get_entity_tasks, link_task_entity, unlink_task_entity, suggest_task_links.

On this page