Skip to main content

UseAcpOptions

Agent Runtimes

Agent Runtimes / hooks/useAcp / UseAcpOptions

Interface: UseAcpOptions

Defined in: src/hooks/useAcp.tsx:113

Properties​

agentId​

agentId: string

Defined in: src/hooks/useAcp.tsx:117

Agent ID to connect to

autoConnect?​

optional autoConnect?: boolean

Defined in: src/hooks/useAcp.tsx:119

Whether to auto-connect on mount (default: true)

onConnectionChange?​

optional onConnectionChange?: (state) => void

Defined in: src/hooks/useAcp.tsx:127

Callback when connection state changes

Parameters​

state​

ConnectionState

Returns​

void

onError?​

optional onError?: (error) => void

Defined in: src/hooks/useAcp.tsx:131

Callback on error

Parameters​

error​

Error

Returns​

void

onPermissionRequest?​

optional onPermissionRequest?: (request) => void

Defined in: src/hooks/useAcp.tsx:129

Callback when a permission is requested

Parameters​

request​

PendingPermission

Returns​

void

onStreamEvent?​

optional onStreamEvent?: (event) => void

Defined in: src/hooks/useAcp.tsx:125

Callback when a stream event is received

Parameters​

event​

StreamEvent

Returns​

void

reconnectAttempts?​

optional reconnectAttempts?: number

Defined in: src/hooks/useAcp.tsx:121

Number of reconnection attempts (default: 3)

reconnectDelay?​

optional reconnectDelay?: number

Defined in: src/hooks/useAcp.tsx:123

Delay between reconnection attempts in ms (default: 2000)

wsUrl​

wsUrl: string

Defined in: src/hooks/useAcp.tsx:115

WebSocket URL of the ACP-compatible agent server