strands.experimental.hooks.multiagent.events
¶
Multi-agent execution lifecycle events for hook system integration.
These events are fired by orchestrators (Graph/Swarm) at key points so hooks can persist, monitor, or debug execution. No intermediate state model is used—hooks read from the orchestrator directly.
AfterMultiAgentInvocationEvent
dataclass
¶
Bases: BaseHookEvent
Event triggered after orchestrator execution completes.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
MultiAgentBase
|
The multi-agent orchestrator instance |
invocation_state |
dict[str, Any] | None
|
Configuration that user passes in |
Source code in strands/experimental/hooks/multiagent/events.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |
should_reverse_callbacks
property
¶
True to invoke callbacks in reverse order.
AfterNodeCallEvent
dataclass
¶
Bases: BaseHookEvent
Event triggered after individual node execution completes.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
MultiAgentBase
|
The multi-agent orchestrator instance |
node_id |
str
|
ID of the node that just completed execution |
invocation_state |
dict[str, Any] | None
|
Configuration that user passes in |
Source code in strands/experimental/hooks/multiagent/events.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | |
should_reverse_callbacks
property
¶
True to invoke callbacks in reverse order.
BaseHookEvent
dataclass
¶
Base class for all hook events.
Source code in strands/hooks/registry.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
should_reverse_callbacks
property
¶
Determine if callbacks for this event should be invoked in reverse order.
Returns:
| Type | Description |
|---|---|
bool
|
False by default. Override to return True for events that should |
bool
|
invoke callbacks in reverse order (e.g., cleanup/teardown events). |
__post_init__()
¶
Disallow writes to non-approved properties.
Source code in strands/hooks/registry.py
48 49 50 51 52 | |
__setattr__(name, value)
¶
Prevent setting attributes on hook events.
Raises:
| Type | Description |
|---|---|
AttributeError
|
Always raised to prevent setting attributes on hook events. |
Source code in strands/hooks/registry.py
54 55 56 57 58 59 60 61 62 63 64 65 66 | |
BeforeMultiAgentInvocationEvent
dataclass
¶
Bases: BaseHookEvent
Event triggered before orchestrator execution starts.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
MultiAgentBase
|
The multi-agent orchestrator instance |
invocation_state |
dict[str, Any] | None
|
Configuration that user passes in |
Source code in strands/experimental/hooks/multiagent/events.py
90 91 92 93 94 95 96 97 98 99 100 | |
BeforeNodeCallEvent
dataclass
¶
Bases: BaseHookEvent, _Interruptible
Event triggered before individual node execution starts.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
MultiAgentBase
|
The multi-agent orchestrator instance |
node_id |
str
|
ID of the node about to execute |
invocation_state |
dict[str, Any] | None
|
Configuration that user passes in |
cancel_node |
bool | str
|
A user defined message that when set, will cancel the node execution with status FAILED.
The message will be emitted under a MultiAgentNodeCancel event. If set to |
Source code in strands/experimental/hooks/multiagent/events.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | |
MultiAgentBase
¶
Bases: ABC
Base class for multi-agent helpers.
This class integrates with existing Strands Agent instances and provides multi-agent orchestration capabilities.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
Unique MultiAgent id for session management,etc. |
Source code in strands/multiagent/base.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | |
__call__(task, invocation_state=None, **kwargs)
¶
Invoke synchronously.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task
|
MultiAgentInput
|
The task to execute |
required |
invocation_state
|
dict[str, Any] | None
|
Additional state/context passed to underlying agents. Defaults to None to avoid mutable default argument issues. |
None
|
**kwargs
|
Any
|
Additional keyword arguments passed to underlying agents. |
{}
|
Source code in strands/multiagent/base.py
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | |
deserialize_state(payload)
¶
Restore orchestrator state from a session dict.
Source code in strands/multiagent/base.py
252 253 254 | |
invoke_async(task, invocation_state=None, **kwargs)
abstractmethod
async
¶
Invoke asynchronously.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task
|
MultiAgentInput
|
The task to execute |
required |
invocation_state
|
dict[str, Any] | None
|
Additional state/context passed to underlying agents. Defaults to None to avoid mutable default argument issues. |
None
|
**kwargs
|
Any
|
Additional keyword arguments passed to underlying agents. |
{}
|
Source code in strands/multiagent/base.py
189 190 191 192 193 194 195 196 197 198 199 200 201 | |
serialize_state()
¶
Return a JSON-serializable snapshot of the orchestrator state.
Source code in strands/multiagent/base.py
248 249 250 | |
stream_async(task, invocation_state=None, **kwargs)
async
¶
Stream events during multi-agent execution.
Default implementation executes invoke_async and yields the result as a single event. Subclasses can override this method to provide true streaming capabilities.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task
|
MultiAgentInput
|
The task to execute |
required |
invocation_state
|
dict[str, Any] | None
|
Additional state/context passed to underlying agents. Defaults to None to avoid mutable default argument issues. |
None
|
**kwargs
|
Any
|
Additional keyword arguments passed to underlying agents. |
{}
|
Yields:
| Type | Description |
|---|---|
AsyncIterator[dict[str, Any]]
|
Dictionary events containing multi-agent execution information including: |
AsyncIterator[dict[str, Any]]
|
|
AsyncIterator[dict[str, Any]]
|
|
AsyncIterator[dict[str, Any]]
|
|
Source code in strands/multiagent/base.py
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | |
MultiAgentInitializedEvent
dataclass
¶
Bases: BaseHookEvent
Event triggered when multi-agent orchestrator initialized.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
MultiAgentBase
|
The multi-agent orchestrator instance |
invocation_state |
dict[str, Any] | None
|
Configuration that user passes in |
Source code in strands/experimental/hooks/multiagent/events.py
21 22 23 24 25 26 27 28 29 30 31 | |
_Interruptible
¶
Bases: Protocol
Interface that adds interrupt support to hook events and tools.
Source code in strands/types/interrupt.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | |
interrupt(name, reason=None, response=None)
¶
Trigger the interrupt with a reason.
reason: User provided reason for the interrupt.
response: Preemptive response from user if available.
Returns:
| Type | Description |
|---|---|
Any
|
The response from a human user when resuming from an interrupt state. |
Raises:
| Type | Description |
|---|---|
InterruptException
|
If human input is required. |
RuntimeError
|
If agent instance attribute not set. |
Source code in strands/types/interrupt.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |