Skip to content

LoomStartGiftRequest

Threads handed to one agent of an interaction as its run starts, such as the context an agent passes to a helper it starts. Each arrives as a gift, marked with where it came from, before the agent’s first tapestry is woven, so it wakes up knowing it, and knowing it was told.

Kind: an object, used in requests.

FieldTypeRequiredDescription
agentNamestringyesThe participant that receives the threads. Constraints: required (empty or whitespace-only strings are rejected).
fromLoomIduuidThe id of the loom the threads come from. It must be one of your tenant’s.
threadIdsuuid[]yesThe full ids of threads in that loom, 1 to 20. Only knowledge is handed over: never knots, private notes, reflections or episodes. Constraints: required (empty or whitespace-only strings are rejected).
notestring | nullA sentence the agent reads with the threads.
givenBystring | nullWho the agent is told gave it the threads, such as "Wren" for an agent handing work to a helper; at most 60 characters. Default: "whoever started this conversation".
{
"agentName": "...",
"fromLoomId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
"threadIds": [
"3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f"
],
"note": "...",
"givenBy": "..."
}