DOCSAPI reference

INTERFACE

AgentMessage

Defined in: packages/components/src/agents/types.ts:42

A chat message exchanged between an agent and its model.

Properties

Property Type Description Defined in
content string Text content. packages/components/src/agents/types.ts:46
metadata? Record<string, unknown> Application data attached to the message. Models do not read it. packages/components/src/agents/types.ts:52
role string Message role, such as system, user, assistant or tool. packages/components/src/agents/types.ts:44
tool_call_id? string For tool messages: the identifier of the call this message answers. packages/components/src/agents/types.ts:50
tool_calls? AgentToolCall[] Tool calls requested by an assistant message. packages/components/src/agents/types.ts:48
usage? TokenUsage Token usage of the reply that produced this message. packages/components/src/agents/types.ts:54