Interface: AgentSendMessageOptions

blocks: { content: string; type: "text"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "image"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "document"; } | { attachmentType: "file" | "directory"; displayName?: string; fileName: string; filePath: string; source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "attachment"; } | { content: string; metadata?: Record<string, unknown>; type: "reasoning"; } | { args: Record<string, unknown>; name: string; toolCallId: string; type: "tool_call"; } | { isError?: boolean; output: string; toolCallId: string; type: "tool_output"; } | ({ content: string; type: "text"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "image"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "document"; } | { attachmentType: "file" | "directory"; displayName?: string; fileName: string; filePath: string; source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "attachment"; } | { content: string; metadata?: Record<string, unknown>; type: "reasoning"; } | { args: Record<string, unknown>; name: string; toolCallId: string; type: "tool_call"; } | { isError?: boolean; output: string; toolCallId: string; type: "tool_output"; })[]

Union Members

Type Literal

{ content: string; type: "text"; }

Type Literal

{ source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "image"; }

Type Literal

{ source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "document"; }

Type Literal

{ attachmentType: "file" | "directory"; displayName?: string; fileName: string; filePath: string; source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "attachment"; }

attachmentType

attachmentType: "file" | "directory" = AttachmentTypeSchema

Whether the attachment is a file or directory

displayName?

optional displayName?: string

Optional human-readable display name override

fileName

fileName: string

Original filename with extension (e.g. “api-spec.yaml”) — for display and type inference

filePath

filePath: string

Server-side file path — always populated before message reaches adapters

source

source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; } = ContentSourceSchema

Inline content — base64 for binary, raw string for text

type

type: "attachment"

Type Literal

{ content: string; metadata?: Record<string, unknown>; type: "reasoning"; }

content

content: string

metadata?

optional metadata?: Record<string, unknown>

Optional provider/runtime metadata for reasoning blocks.

type

type: "reasoning"

Type Literal

{ args: Record<string, unknown>; name: string; toolCallId: string; type: "tool_call"; }

Type Literal

{ isError?: boolean; output: string; toolCallId: string; type: "tool_output"; }

({ content: string; type: "text"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "image"; } | { source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "document"; } | { attachmentType: "file" | "directory"; displayName?: string; fileName: string; filePath: string; source: { data: string; mimeType: string; type: "base64"; } | { mimeType?: string; type: "url"; url: string; }; type: "attachment"; } | { content: string; metadata?: Record<string, unknown>; type: "reasoning"; } | { args: Record<string, unknown>; name: string; toolCallId: string; type: "tool_call"; } | { isError?: boolean; output: string; toolCallId: string; type: "tool_output"; })[]

role?

optional role?: "user" | "assistant" | "system"

messageId?

optional messageId?: string

Defined in: ../../../adapters/core/src/message-handle/types.ts:32

Custom identifier for message tracking (generated if not provided).

Inherited from

SendMessageOptions.messageId

responseSchema?

optional responseSchema?: Record<string, unknown>

Defined in: ../../../adapters/core/src/agent/types.ts:282

JSON Schema for structured output. When present and the adapter declares structuredOutput capability, the adapter enforces this schema at the model level. Ignored by adapters that lack the capability.

sessionContext?

optional sessionContext?: object

Defined in: ../../../adapters/core/src/agent/types.ts:274

Context signals assembled by SessionOrchestrator. Used by AIAgent to decide: native resume vs fresh with history. Hooks inject context via sessionContext.turnContext (set by replacePayload).

extractedContext?

optional extractedContext?: unknown

Structured context from compression (if hasCompression=true).

hasCompression?

optional hasCompression?: boolean

Whether compression is active (extractedContext present). If true, Agent should use fresh mode with compressed context.

hasConnectorSwap?

optional hasConnectorSwap?: boolean

Whether a connector swap occurred before this message (e.g., cwd/model change). If true, native resume is infeasible and adapters should use fresh mode.

hasNewTransforms?

optional hasNewTransforms?: boolean

Whether transforms have been applied since last turn. If true, Agent should use fresh mode (history changed).

isFirstTurn?

optional isFirstTurn?: boolean

Whether this is the first turn in the session. If true, no native history exists yet.

messageHistory?

optional messageHistory?: object[]

Curated message history assembled via getFullConversation(). Only used if Agent decides to inject (fresh mode).

turnContext?

optional turnContext?: Record<string, JsonValue>

Turn-scoped context assembled by PreUserMessage hooks and the orchestrator. Keys are plugin-defined (e.g., ‘skillCatalog’, ‘skills’, ‘predictedTools’). Adapters consume this to prepend context blocks.

Constrained to JSON-safe types to ensure serialization succeeds.

ADAPTER CONTRACT: Every adapter MUST materialize turnContext into the LLM-facing message using serializeTurnContext().

systemPrompt?

optional systemPrompt?: string | { content: string; mode: "append"; }

Defined in: ../../../adapters/core/src/agent/types.ts:267

System prompt configuration.

string: Replace/set the entire system prompt
{ mode: 'append', content: string }: Append to adapter’s default system prompt