Skip to content

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.

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

FieldTypeDescription
iduuidThe wait’s id.
processIdsuuid[]The runs waited on.
allbooleanTrue: the wait is over when every one has ended. False: when any one has.
participantNamestringThe participant waiting.
threadIdstring | nullThe conversation thread the participant’s call is on. Null is the main thread.
takenByVersionReference| nullThe 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.
dateStarteddatetimeWhen the wait started (UTC).
{
"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"
}