InteractionSwarmAwait
A participant waiting on sub-interactions it started. The run waits (AwaitingChildren) until the wait is over; then the participant reads every awaited run’s result as the result of its call.
Kind: an object, used in responses.
Fields
Section titled “Fields”Every field is present in a response; empty ones are null.
| Field | Type | Description |
|---|---|---|
id | uuid | The wait’s id. |
processIds | uuid[] | The runs waited on. |
all | boolean | True: the wait is over when every one has ended. False: when any one has. |
participantName | string | The participant waiting. |
threadId | string | null | The conversation thread the participant’s call is on. Null is the main thread. |
takenBy | VersionReference| null | The agent that was taking the participant’s turn when it waited, when that is not the agent its definition binds (a routed participant’s chosen agent): the turn carries on as that agent once the wait is over. Null otherwise. |
dateStarted | datetime | When the wait started (UTC). |
Example
Section titled “Example”{ "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f", "processIds": [ "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f" ], "all": false, "participantName": "...", "threadId": "...", "takenBy": { "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f", "version": 0 }, "dateStarted": "2026-10-26T12:00:00.0000000Z"}Where it’s used
Section titled “Where it’s used”- Inside
InteractionProcessSwarm