ChatProps

Agent Runtimes

---

Agent Runtimes / chat/Chat / ChatProps

Interface: ChatProps

Defined in: chat/Chat.tsx:122

Chat props

Properties

agentId?

optional agentId?: string

Defined in: chat/Chat.tsx:136

Agent ID

---

authToken?

optional authToken?: string

Defined in: chat/Chat.tsx:139

Authentication token (JWT) to send as Authorization Bearer header

---

autoConnect?

optional autoConnect?: boolean

Defined in: chat/Chat.tsx:151

Whether to auto-connect on mount

---

autoFocus?

optional autoFocus?: boolean

Defined in: chat/Chat.tsx:242

Auto-focus the input on mount

---

availableModels?

optional availableModels?: ModelConfig[]

Defined in: chat/Chat.tsx:215

Override the list of available models. When provided, this list replaces the models returned by the config endpoint. Use this to restrict the model selector to a specific subset of models.

---

baseUrl?

optional baseUrl?: string

Defined in: chat/Chat.tsx:130

Base URL of the server (for HTTP-based protocols)

---

brandIcon?

optional brandIcon?: ReactNode

Defined in: chat/Chat.tsx:148

Brand icon shown in chat header/empty state and details title

---

chatViewMode?

optional chatViewMode?: ChatViewMode

Defined in: chat/Chat.tsx:300

Current chat view mode for the header segmented toggle. When provided, a view-mode toggle is rendered in the header.

---

className?

optional className?: string

Defined in: chat/Chat.tsx:172

Custom styles

---

clearOnMount?

optional clearOnMount?: boolean

Defined in: chat/Chat.tsx:224

Clear messages when component mounts or agentId changes

---

codemodeEnabled?

optional codemodeEnabled?: boolean

Defined in: chat/Chat.tsx:199

Indicate tools are accessed via Codemode meta-tools

---

contextSnapshot?

optional contextSnapshot?: ContextSnapshotData

Defined in: chat/Chat.tsx:326

External context snapshot data for the token usage bar. When provided, overrides the built-in (no-op) useContextSnapshot hook.

---

description?

optional description?: string

Defined in: chat/Chat.tsx:233

Description shown in empty state

---

errorBanner?

optional errorBanner?: object

Defined in: chat/Chat.tsx:284

Error banner to display at the top of the chat. Use this to show sandbox connection errors or other warnings.

message

message: string

variant?

optional variant?: "warning" | "danger"

---

extensions?

optional extensions?: Extension[]

Defined in: chat/Chat.tsx:127

Extensions for chat features

---

frontendTools?

optional frontendTools?: FrontendToolDefinition<Record<string, unknown>, unknown>[]

Defined in: chat/Chat.tsx:311

Frontend tool definitions to register with the chat. Pass an empty array to explicitly disable all frontend tools.

---

headerActions?

optional headerActions?: ReactNode

Defined in: chat/Chat.tsx:239

Custom actions to render in the chat header title row (right side).

---

headerContent?

optional headerContent?: ReactNode

Defined in: chat/Chat.tsx:236

Custom content to render in the chat header title row (left side).

---

height?

optional height?: string | number

Defined in: chat/Chat.tsx:175

Height of the chat container

---

hideMessagesAfterToolUI?

optional hideMessagesAfterToolUI?: boolean

Defined in: chat/Chat.tsx:320

Hide assistant messages that follow a rendered tool call UI. Useful to suppress raw tool-call/continuation text and show only tool cards.

---

historyEndpoint?

optional historyEndpoint?: string

Defined in: chat/Chat.tsx:272

Endpoint URL for fetching conversation history. When runtimeId is provided, this endpoint is called to fetch the conversation history on mount. If not provided, defaults to {protocol.endpoint}/api/v1/history.

---

identityProviders?

optional identityProviders?: object

Defined in: chat/Chat.tsx:245

Identity providers configuration for OAuth

custom?

optional custom?: object

custom.clientId

clientId: string

custom.config?

optional config?: Partial<OAuthProviderConfig>

custom.scopes?

optional scopes?: string[]

github?

optional github?: object

github.clientId

clientId: string

github.config?

optional config?: Partial<OAuthProviderConfig>

github.scopes?

optional scopes?: string[]

google?

optional google?: object

google.clientId

clientId: string

google.config?

optional config?: Partial<OAuthProviderConfig>

google.scopes?

optional scopes?: string[]

kaggle?

optional kaggle?: object

kaggle.clientId

clientId: string

kaggle.config?

optional config?: Partial<OAuthProviderConfig>

kaggle.scopes?

optional scopes?: string[]

linkedin?

optional linkedin?: object

linkedin.clientId

clientId: string

linkedin.config?

optional config?: Partial<OAuthProviderConfig>

linkedin.scopes?

optional scopes?: string[]

notion?

optional notion?: object

notion.clientId

clientId: string

notion.config?

optional config?: Partial<OAuthProviderConfig>

notion.scopes?

optional scopes?: string[]

slack?

optional slack?: object

slack.clientId

clientId: string

slack.config?

optional config?: Partial<OAuthProviderConfig>

slack.scopes?

optional scopes?: string[]

---

initialModel?

optional initialModel?: string

Defined in: chat/Chat.tsx:208

Initial model ID to select (e.g., 'openai:gpt-4o-mini')

---

initialSkills?

optional initialSkills?: string[]

Defined in: chat/Chat.tsx:221

Initial skill IDs to enable

---

mcpServers?

optional mcpServers?: McpServerSelection[]

Defined in: chat/Chat.tsx:218

MCP server selections to enable (others will be disabled)

---

mcpStatusData?

optional mcpStatusData?: McpToolsetsStatusResponse | null

Defined in: chat/Chat.tsx:332

External MCP toolsets status data for the MCP indicator. When provided, the data is forwarded to the McpStatusIndicator.

---

onChatViewModeChange?

optional onChatViewModeChange?: (mode) => void

Defined in: chat/Chat.tsx:305

Callback when the user switches chat view mode via the header toggle.

Parameters

mode

ChatViewMode

Returns

void

---

onCollapsePanel?

optional onCollapsePanel?: () => void

Defined in: chat/Chat.tsx:169

Callback when collapse panel is clicked

Returns

void

---

onDisconnect?

optional onDisconnect?: () => void

Defined in: chat/Chat.tsx:163

Callback when disconnect is clicked

Returns

void

---

onIdentityConnect?

optional onIdentityConnect?: (identity) => void

Defined in: chat/Chat.tsx:254

Callback when identity connects

Parameters

identity

Identity

Returns

void

---

onIdentityDisconnect?

optional onIdentityDisconnect?: (provider) => void

Defined in: chat/Chat.tsx:257

Callback when identity disconnects

Parameters

provider

OAuthProvider

Returns

void

---

onLogout?

optional onLogout?: () => void

Defined in: chat/Chat.tsx:166

Callback when logout is clicked

Returns

void

---

onMessageReceived?

optional onMessageReceived?: (message) => void

Defined in: chat/Chat.tsx:160

Callback when a response is received

Parameters

message

unknown

Returns

void

---

onMessageSent?

optional onMessageSent?: (content) => void

Defined in: chat/Chat.tsx:157

Callback when a message is sent

Parameters

content

string

Returns

void

---

pendingPrompt?

optional pendingPrompt?: string

Defined in: chat/Chat.tsx:278

A prompt to append and send after the conversation history is loaded. The message is shown in the chat and sent to the agent exactly once.

---

placeholder?

optional placeholder?: string

Defined in: chat/Chat.tsx:142

Custom placeholder text

---

protocol

protocol: Protocol

Defined in: chat/Chat.tsx:124

Transport to use

---

renderToolResult?

optional renderToolResult?: RenderToolResult

Defined in: chat/Chat.tsx:314

Optional custom renderer for tool-call message cards.

---

runtimeId?

optional runtimeId?: string

Defined in: chat/Chat.tsx:264

Runtime ID for conversation persistence. When provided, messages are fetched from the server API on page reload and prevents message mixing between different agent runtimes.

---

showClearButton?

optional showClearButton?: boolean

Defined in: chat/Chat.tsx:184

Show the clear chat button in the header

---

showHeader?

optional showHeader?: boolean

Defined in: chat/Chat.tsx:178

Show header with connection status

---

showInformation?

optional showInformation?: boolean

Defined in: chat/Chat.tsx:294

Show the information icon in the header. When clicked, it opens the agent details panel.

Default

false

---

showInput?

optional showInput?: boolean

Defined in: chat/Chat.tsx:193

Show input area

---

showModelSelector?

optional showModelSelector?: boolean

Defined in: chat/Chat.tsx:187

Show model selector (fetched from /configure endpoint)

---

showNewChatButton?

optional showNewChatButton?: boolean

Defined in: chat/Chat.tsx:181

Show the new chat (+) button in the header

---

showSkillsMenu?

optional showSkillsMenu?: boolean

Defined in: chat/Chat.tsx:196

Show skills menu (fetched from /skills endpoint)

---

showTokenUsage?

optional showTokenUsage?: boolean

Defined in: chat/Chat.tsx:205

Show token usage bar between input and selectors.

Default

true

---

showToolsMenu?

optional showToolsMenu?: boolean

Defined in: chat/Chat.tsx:190

Show tools menu (fetched from /configure endpoint)

---

streaming?

optional streaming?: boolean

Defined in: chat/Chat.tsx:154

Whether to use streaming (for protocols that support it)

---

submitOnSuggestionClick?

optional submitOnSuggestionClick?: boolean

Defined in: chat/Chat.tsx:230

Whether to automatically submit the message when a suggestion is clicked

---

suggestions?

optional suggestions?: Suggestion[]

Defined in: chat/Chat.tsx:227

Suggestions to show in empty state

---

title?

optional title?: string

Defined in: chat/Chat.tsx:145

Custom title

---

wsUrl?

optional wsUrl?: string

Defined in: chat/Chat.tsx:133

WebSocket URL (for WebSocket-based protocols like ACP)