Skip to main content

Virtual Tool Result

Companion of AI::VirtualAgent conversation memory: writes a tool's outcome back into the agent's session. When an agent with memory enabled calls an AI::VirtualTool, it persists the assistant turn — including the pending tool call — in the session. Wire the same session_id the agent received and the firing tool's tool_call_id output into this node, plus whatever the tool branch computed on content: the result is appended to the session as a tool message answering that call, so the agent knows what happened on the user's next turn. Sessions are organization-wide — one session id is one conversation.

With Respond to the user enabled, the node then calls the model back with the updated conversation — without tools, so the reply is always plain text — and emits the model's user-facing answer on the response output ("Done — your meeting is booked for Friday"). The reply is also appended to the session.

Pre-requisite (only when responding): Install an AI provider application from Profile > {Organization} > Applications.

Parameters​

Respond to the user

When on, after recording the result the model is called back with the conversation so it can phrase the outcome to the user; the reply is emitted on the response output connector.

Provider

Only shown when responding. Configured AI application used for the continuation call.

Model

Only shown when responding. Model identifier for the continuation call. Defaults to the provider's recommended model when left empty.

Context

Only shown when responding. System prompt for the continuation call — how the model should turn the recorded outcome into the user-facing answer. The agent's own system prompt is not persisted in the conversation, so set this whenever responding is enabled.

Memory TTL (seconds)

Conversation TTL (default 3600); should match the agent's memory TTL, since recording a result refreshes the session expiry with this value.

Max replayed messages

History size cap (default 20); should match the agent's max replayed messages.

Input​

Session IDrequired

The conversation session identifier — the same value wired into the parent AI::VirtualAgent's session_id input. PlainText or Integer.

Tool Call IDrequired

The call identifier emitted by the firing AI::VirtualTool — it links the recorded result to the pending tool call in the conversation.

Contentrequired

The tool's outcome to record. PlainText is stored as-is, Integer is converted to its string representation, JSON is serialized to a JSON string.

Output​

Value

The recorded content, passed through as PlainText.

Response

Only present when Respond to the user is on. The model's plain-text, user-facing answer built from the updated conversation.