Skip to main content

AgentLifecycleOptions

Agent Runtimes

Agent Runtimes / hooks/useCheckpoints / AgentLifecycleOptions

Interface: AgentLifecycleOptions

Defined in: src/hooks/useCheckpoints.ts:392

Options for useAgentLifecycle.

Properties​

agentSpec?​

optional agentSpec?: Record<string, any>

Defined in: src/hooks/useCheckpoints.ts:396

Full agent spec object (persisted with checkpoints)

agentSpecId?​

optional agentSpecId?: string

Defined in: src/hooks/useCheckpoints.ts:394

Agent spec ID (identifies the agent for lifecycle management)

connectToRuntime​

connectToRuntime: (opts) => void

Defined in: src/hooks/useCheckpoints.ts:400

Callback to connect to a new runtime pod

Parameters​

opts​
environmentName​

string

jupyterBaseUrl?​

string

podName​

string

Returns​

void

disconnect​

disconnect: () => void

Defined in: src/hooks/useCheckpoints.ts:406

Callback to disconnect from the runtime

Returns​

void

launchRuntime​

launchRuntime: () => Promise<AgentConnection>

Defined in: src/hooks/useCheckpoints.ts:408

Callback to launch a new runtime

Returns​

Promise<AgentConnection>

onResetAgentCreation?​

optional onResetAgentCreation?: () => void

Defined in: src/hooks/useCheckpoints.ts:413

Callback fired when the hook needs to signal that the agent should be re-created on a (possibly new) pod.

Returns​

void

runtime​

runtime: AgentConnection | null

Defined in: src/hooks/useCheckpoints.ts:398

Current runtime connection from the agent store