Skip to content

SubagentHandleData

Defined in: packages/ai/src/types.ts:638

One child invocation as the client sees it. AG-UI SubagentInfo names the child; the other AG-UI fields come from its SUBAGENT_STARTED, SUBAGENT_FINISHED and SUBAGENT_ERROR events. id is the AG-UI subagentRunId. status, parentRunId and messages are client state the spec does not model.

Extends

  • SubagentInfo.Pick<AGUISubagentStartedEvent, "parentSubagentRunId" | "parentToolCallId" | "metadata">

Properties

error?

ts
optional error?: Pick<SubagentErrorEvent, "message" | "code">;

Defined in: packages/ai/src/types.ts:652


id

ts
id: string;

Defined in: packages/ai/src/types.ts:645


interruptIds?

ts
optional interruptIds?: string[];

Defined in: packages/ai/src/types.ts:650

Interrupts this child raised, while status is 'suspended'.


messages

ts
messages: UIMessage<unknown>[];

Defined in: packages/ai/src/types.ts:651


parentRunId?

ts
optional parentRunId?: string;

Defined in: packages/ai/src/types.ts:648

The parent chat run that started this child.


status

ts
status: SubagentStatus;

Defined in: packages/ai/src/types.ts:646