UseAgentOptions

Agent Runtimes

---

Agent Runtimes / hooks/useAgentRuntimes / UseAgentOptions

Interface: UseAgentOptions

Defined in: hooks/useAgentRuntimes.ts:51

Options for the useAgents hook.

Properties

agentConfig?

optional agentConfig?: AgentConfig

Defined in: hooks/useAgentRuntimes.ts:55

Agent configuration

---

agentSpec?

optional agentSpec?: Record<string, any>

Defined in: hooks/useAgentRuntimes.ts:61

Full agent spec object (persisted with checkpoints)

---

agentSpecId?

optional agentSpecId?: string

Defined in: hooks/useAgentRuntimes.ts:53

Agent spec ID — when provided, enables full lifecycle management (launch, pause, resume, terminate)

---

autoCreateAgent?

optional autoCreateAgent?: boolean

Defined in: hooks/useAgentRuntimes.ts:57

Auto-create agent when runtime connects (default: true)

---

autoStart?

optional autoStart?: boolean

Defined in: hooks/useAgentRuntimes.ts:59

Auto-start runtime on mount (default: false)