Skip to main content

README

Agent Runtimes

Agent Runtimes / hooks

hooks

Hooks for agent-runtimes.

This module exports hooks organized by their purpose:

Chat Component System Hooks​

These hooks work with the Zustand-based chat component system. Use these when building with <Chat />, <ChatSidebar />, etc.

  • useChat - Main chat hook for messages, streaming, and state
  • useFrontendTool, useBackendTool - Tool registration hooks

Transport-Specific Hooks​

These hooks provide direct protocol access without the chat component system. Use these for custom implementations or when you need fine-grained control.

  • useAgUi - AG-UI protocol (Pydantic AI's native protocol)
  • useA2A - A2A protocol (Agent-to-Agent with JSON-RPC)
  • useAcp - ACP protocol (Agent Client Protocol via WebSocket)
  • useVercelAI - Vercel AI SDK chat protocol

Datalayer-Specific Hooks​

Hooks for Datalayer platform integration.

  • useAgentsService - Datalayer AI Agents REST API
  • useNotebookAgents - Notebook-specific agent management

References​

ActionRegistrar​

Re-exports ActionRegistrar

Agent​

Re-exports Agent

AGENT_QUERY_OPTIONS​

Re-exports AGENT_QUERY_OPTIONS

AgentCatalogStoreState​

Re-exports AgentCatalogStoreState

AgentLifecycleOptions​

Re-exports AgentLifecycleOptions

AgentLifecycleReturn​

Re-exports AgentLifecycleReturn

agentQueryKeys​

Re-exports agentQueryKeys

AIAgentsWebSocketCloseInfo​

Re-exports AIAgentsWebSocketCloseInfo

AIAgentsWebSocketConnectionState​

Re-exports AIAgentsWebSocketConnectionState

CheckpointAgentParams​

Re-exports CheckpointAgentParams

CheckpointData​

Re-exports CheckpointData

ConnectionState​

Re-exports ConnectionState

fetchOtelMetricRows​

Re-exports fetchOtelMetricRows

fetchOtelMetricTotal​

Re-exports fetchOtelMetricTotal

fetchOtelTotalTokens​

Re-exports fetchOtelTotalTokens

getAgentLifecycleKey​

Re-exports getAgentLifecycleKey

Message​

Re-exports Message

PauseAgentParams​

Re-exports PauseAgentParams

PendingPermission​

Re-exports PendingPermission

ResumeAgentParams​

Re-exports ResumeAgentParams

Session​

Re-exports Session

SessionUpdateType​

Re-exports SessionUpdateType

StreamEvent​

Re-exports StreamEvent

TerminateAgentParams​

Re-exports TerminateAgentParams

toMetricValue​

Re-exports toMetricValue

useA2A​

Re-exports useA2A

useAcp​

Re-exports useAcp

UseAcpOptions​

Re-exports UseAcpOptions

UseAcpReturn​

Re-exports UseAcpReturn

useAgentCatalogStore​

Re-exports useAgentCatalogStore

useAgentEvent​

Re-exports useAgentEvent

useAgentEvents​

Re-exports useAgentEvents

useAgentLifecycle​

Re-exports useAgentLifecycle

useAgentLifecycleStore​

Re-exports useAgentLifecycleStore

useAgentRegistry​

Re-exports useAgentRegistry

useAgentRuntimeByPodName​

Re-exports useAgentRuntimeByPodName

useAgentRuntimes​

Re-exports useAgentRuntimes

useAgentRuntimesQuery​

Re-exports useAgentRuntimesQuery

useAgentRuntimeWebSocket​

Re-exports useAgentRuntimeWebSocket

UseAgentRuntimeWebSocketOptions​

Re-exports UseAgentRuntimeWebSocketOptions

useAgentsRuntimes​

Re-exports useAgentsRuntimes

useAgentsService​

Re-exports useAgentsService

useAgUi​

Re-exports useAgUi

useAIAgentsWebSocket​

Re-exports useAIAgentsWebSocket

UseAIAgentsWebSocketOptions​

Re-exports UseAIAgentsWebSocketOptions

UseAIAgentsWebSocketResult​

Re-exports UseAIAgentsWebSocketResult

useAllAgentEvents​

Re-exports useAllAgentEvents

useApproveToolRequest​

Re-exports useApproveToolRequest

useBackendTool​

Re-exports useBackendTool

useChat​

Re-exports useChat

UseChatReturn​

Re-exports UseChatReturn

useCheckpointAgent​

Re-exports useCheckpointAgent

useCheckpoints​

Re-exports useCheckpoints

useCheckpointsQuery​

Re-exports useCheckpointsQuery

useConfig​

Re-exports useConfig

useContextSnapshot​

Re-exports useContextSnapshot

useCreateAgentEvent​

Re-exports useCreateAgentEvent

useCreateAgentRuntime​

Re-exports useCreateAgentRuntime

useDeleteAgentEvent​

Re-exports useDeleteAgentEvent

useDeleteAgentRuntime​

Re-exports useDeleteAgentRuntime

useDeletePausedAgentRuntime​

Re-exports useDeletePausedAgentRuntime

useFilteredNotifications​

Re-exports useFilteredNotifications

useFrontendTool​

Re-exports useFrontendTool

UseFrontendToolFn​

Re-exports UseFrontendToolFn

useMarkAllNotificationsRead​

Re-exports useMarkAllNotificationsRead

useMarkEventRead​

Re-exports useMarkEventRead

useMarkEventUnread​

Re-exports useMarkEventUnread

useMarkNotificationRead​

Re-exports useMarkNotificationRead

useNotebookAgents​

Re-exports useNotebookAgents

useNotifications​

Re-exports useNotifications

useOtelTotalTokens​

Re-exports useOtelTotalTokens

usePauseAgent​

Re-exports usePauseAgent

usePendingApprovalCount​

Re-exports usePendingApprovalCount

usePendingToolCalls​

Re-exports usePendingToolCalls

useRefreshAgentRuntimes​

Re-exports useRefreshAgentRuntimes

useRefreshCheckpoints​

Re-exports useRefreshCheckpoints

useRegisteredTools​

Re-exports useRegisteredTools

useRejectToolRequest​

Re-exports useRejectToolRequest

useResumeAgent​

Re-exports useResumeAgent

useResumePausedAgentRuntime​

Re-exports useResumePausedAgentRuntime

useSandbox​

Re-exports useSandbox

useSkills​

Re-exports useSkills

useTerminateAgent​

Re-exports useTerminateAgent

useTool​

Re-exports useTool

useToolApprovals​

Re-exports useToolApprovals

useToolApprovalsQuery​

Re-exports useToolApprovalsQuery

useUnreadNotificationCount​

Re-exports useUnreadNotificationCount

useUpdateAgentEvent​

Re-exports useUpdateAgentEvent

useVercelAI​

Re-exports useVercelAI