UseAgentRuntimeWebSocketOptions

Agent Runtimes

---

Agent Runtimes / hooks/useAgentRuntimes / UseAgentRuntimeWebSocketOptions

Interface: UseAgentRuntimeWebSocketOptions

Defined in: src/hooks/useAgentRuntimes.ts:1177

Properties

agentId?

optional agentId?: string

Defined in: src/hooks/useAgentRuntimes.ts:1188

Optional agent_id query parameter to scope the stream.

---

authToken?

optional authToken?: string

Defined in: src/hooks/useAgentRuntimes.ts:1186

Auth token passed as ?token= query parameter.

---

autoReconnect?

optional autoReconnect?: boolean

Defined in: src/hooks/useAgentRuntimes.ts:1190

Auto-reconnect on unexpected disconnects. Defaults to true.

---

baseUrl

baseUrl: string

Defined in: src/hooks/useAgentRuntimes.ts:1184

Base URL of the agent-runtime server (e.g. http://localhost:8765). The WS path is appended automatically.

---

enabled?

optional enabled?: boolean

Defined in: src/hooks/useAgentRuntimes.ts:1179

Enable/disable the connection. Defaults to true.

---

maxReconnectAttempts?

optional maxReconnectAttempts?: number

Defined in: src/hooks/useAgentRuntimes.ts:1194

Maximum reconnect attempts. Unbounded by default.

---

onMessage?

optional onMessage?: (msg) => void

Defined in: src/hooks/useAgentRuntimes.ts:1196

Additional callback fired for every incoming WS message.

Parameters

msg

payload?

unknown

raw

unknown

type?

string

Returns

void

---

reconnectDelayMs?

optional reconnectDelayMs?: number | ((attempt) => number)

Defined in: src/hooks/useAgentRuntimes.ts:1192

Delay between reconnection attempts (ms). Defaults to 3 000.