Skip to main content

AgentRuntimeChatProps

Agent Runtimes

Agent Runtimes / agents/AgentRuntimeChat / AgentRuntimeChatProps

Interface: AgentRuntimeChatProps

Defined in: src/agents/AgentRuntimeChat.tsx:39

Props for AgentRuntimeChat.

Properties​

agentConfig?​

optional agentConfig?: Partial<AgentConfig>

Defined in: src/agents/AgentRuntimeChat.tsx:73

Override the agent config used when creating the agent.

agentSpecId​

agentSpecId: string

Defined in: src/agents/AgentRuntimeChat.tsx:41

Agentspec id to launch, e.g. gallery-analyze-excel-spreadsheet.

brandIcon?​

optional brandIcon?: ReactNode

Defined in: src/agents/AgentRuntimeChat.tsx:45

Custom brand icon rendered in the header / empty state.

description?​

optional description?: string

Defined in: src/agents/AgentRuntimeChat.tsx:47

Description shown in the empty state.

height?​

optional height?: string | number

Defined in: src/agents/AgentRuntimeChat.tsx:51

Chat height (default: 100% so it fills the enclosing box).

launch?​

optional launch?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:61

When false, the runtime is not launched and the chat renders in a disabled launching state. Useful for anonymous users who must sign in first.

Default​

true

onRuntimeChange?​

optional onRuntimeChange?: (runtime) => void

Defined in: src/agents/AgentRuntimeChat.tsx:75

Optional callback invoked when runtime connection state changes.

Parameters​

runtime​

AgentConnection | null

Returns​

void

overlay?​

optional overlay?: ReactNode

Defined in: src/agents/AgentRuntimeChat.tsx:55

Optional overlay rendered above the (disabled) chat, e.g. a sign-in gate.

protocol?​

optional protocol?: Protocol

Defined in: src/agents/AgentRuntimeChat.tsx:49

Transport protocol (default: vercel-ai).

showHeader?​

optional showHeader?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:69

Show the chat header (default: true).

showModelSelector?​

optional showModelSelector?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:63

Show the model selector control (default: true).

showPoweredBy?​

optional showPoweredBy?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:71

Show the "powered by" tag (default: false).

showSkillsMenu?​

optional showSkillsMenu?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:67

Show the skills menu control (default: true).

showToolsMenu?​

optional showToolsMenu?: boolean

Defined in: src/agents/AgentRuntimeChat.tsx:65

Show the tools menu control (default: true).

suggestions?​

optional suggestions?: Suggestion[]

Defined in: src/agents/AgentRuntimeChat.tsx:53

Suggestion chips shown in the empty state.

title?​

optional title?: string

Defined in: src/agents/AgentRuntimeChat.tsx:43

Human-friendly title shown in the chat header.