LoomStartGift

Threads handed to one agent when its run started (see LoomStartGiftRequest). The agent learns them the first time it wakes.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
agentName	string	The participant that receives the threads.
fromLoomId	uuid	The id of the loom the threads come from.
threadIds	uuid[]	The ids of the threads handed over.
note	string | null	A sentence the agent reads with the threads. Null: none.
givenBy	string	Who the agent is told gave it the threads: "whoever started this conversation" unless the start said.
origin	ThreadOrigin	Who started the run: a person through the API, or an app from its script.

Example

{
  "agentName": "...",
  "fromLoomId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "threadIds": [
    "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f"
  ],
  "note": "...",
  "givenBy": "...",
  "origin": {
    "kind": "Manual",
    "interactionProcessId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "appProcessId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "agentId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "agentName": "...",
    "userId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "nightWeavingId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f"
  }
}

Where it’s used

• Inside InteractionProcess
• Inside InteractionProcessWithDetails