class documentation

class HitlRequest: (source)

View In Hierarchy

A pending human-in-the-loop request extracted from an ADK event.

Warning

This class is experimental and may change in future versions. Use with caution in production environments.

Instance Variable author The agent/node that raised the request.
Instance Variable interrupt_id The id a response must reference. Pass it to hitl_input_response or hitl_confirmation_response.
Instance Variable invocation_id The ADK invocation that is paused on this request.
Instance Variable kind "input" for a human-input node's RequestInput, "tool_confirmation" for a tool confirmation request.
Instance Variable message Human-readable prompt (RequestInput.message or the confirmation hint), if any.
Instance Variable original_function_call For tool confirmations, the gated tool call as {"name": ..., "args": ..., "id": ...} — useful for displaying what is being approved.
Instance Variable payload Custom payload attached to the request, if any.
Instance Variable response_schema JSON schema the response must satisfy (input requests only), if any.

The agent/node that raised the request.

interrupt_id: str = (source)

The id a response must reference. Pass it to hitl_input_response or hitl_confirmation_response.

invocation_id: str | None = (source)

The ADK invocation that is paused on this request.

kind: Literal['input', 'tool_confirmation'] = (source)

"input" for a human-input node's RequestInput, "tool_confirmation" for a tool confirmation request.

message: str | None = (source)

Human-readable prompt (RequestInput.message or the confirmation hint), if any.

original_function_call: dict[str, Any] | None = (source)

For tool confirmations, the gated tool call as {"name": ..., "args": ..., "id": ...} — useful for displaying what is being approved.

payload: Any | None = (source)

Custom payload attached to the request, if any.

response_schema: dict[str, Any] | None = (source)

JSON schema the response must satisfy (input requests only), if any.