Skip to main content

UseAgentOptions

Agent Runtimes

Agent Runtimes / hooks/useAgentRuntimes / UseAgentOptions

Interface: UseAgentOptions

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

Options for the useAgents hook.

Properties​

agentConfig?​

optional agentConfig?: AgentConfig

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

Agent configuration

agentSpec?​

optional agentSpec?: Record<string, any>

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

Full agent spec object (persisted with checkpoints)

agentSpecId?​

optional agentSpecId?: string

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

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

autoCreateAgent?​

optional autoCreateAgent?: boolean

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

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

autoStart?​

optional autoStart?: boolean

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

Auto-start runtime on mount (default: false)

runtimeCreationBaseUrl?​

optional runtimeCreationBaseUrl?: string

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

Explicit base URL for runtime create/list operations.

runtimeCreationTarget?​

optional runtimeCreationTarget?: RuntimeCreationTarget

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

Where runtime create/list operations should be sent.

  • backend-services: use backend runtimes service URL
  • local-agent-runtimes: use local agent-runtimes URL