For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: AgentInstanceUpdateRequest

type AgentInstanceUpdateRequest = object;

Request to update the mutable state of an agent instance.

Properties​

elementInstanceKey​

elementInstanceKey: ElementInstanceKey;

The key of the currently-active element instance for this agent instance. Used for ownership/equality validation against the stored agent instance and, when the supplied key differs from the previous association (re-entry of an ad-hoc sub-process or AI Agent task), appended to elementInstanceKeys with the reverse link updated on the supplied element instance.

metrics?​

optional metrics?: AgentInstanceMetricsDelta;

Metric increments to apply to the aggregate counters.

status?​

optional status?: AgentInstanceUpdateStatusEnum;

The new status of the agent instance.

tools?​

optional tools?: AgentTool[] | null;

The complete list of tools available to the agent, replacing any previously stored tools. When provided, the engine replaces the existing tool list with this value.