Documentation for claude-agent-sdk (0.31.0)

Alphabetic Index

File Listing

README

Namespace Listing A-Z

A

APIRetryMessage (ClaudeAgentSDK)
AgentDefinition (ClaudeAgentSDK)
AssistantMessage (ClaudeAgentSDK)
AsyncHookJSONOutput (ClaudeAgentSDK)
AuthStatusMessage (ClaudeAgentSDK)

B

BaseHookInput (ClaudeAgentSDK)
Break (ClaudeAgentSDK::FiberBoundary)

C

CLIConnectionError (ClaudeAgentSDK)
CLIInstallError (ClaudeAgentSDK)
CLIInstaller (ClaudeAgentSDK)
CLIJSONDecodeError (ClaudeAgentSDK)
CLINotFoundError (ClaudeAgentSDK)
CallbackDispatchScope (ClaudeAgentSDK::FiberBoundary)
ClaudeAgentOptions (ClaudeAgentSDK)
ClaudeAgentSDK
ClaudeSDKError (ClaudeAgentSDK)
Client (ClaudeAgentSDK)
CommandBuilder (ClaudeAgentSDK)
CompactBoundaryMessage (ClaudeAgentSDK)
CompactMetadata (ClaudeAgentSDK)
ConfigChangeHookInput (ClaudeAgentSDK)
Configuration (ClaudeAgentSDK)
ConformanceError (ClaudeAgentSDK::Testing)
ControlRequestTimeoutError (ClaudeAgentSDK)
ConversationResetMessage (ClaudeAgentSDK)
CwdChangedHookInput (ClaudeAgentSDK)
CwdChangedHookSpecificOutput (ClaudeAgentSDK)

D

DeferredToolUse (ClaudeAgentSDK)

E

ElicitationCompleteMessage (ClaudeAgentSDK)
ElicitationHookInput (ClaudeAgentSDK)
ElicitationResultHookInput (ClaudeAgentSDK)

F

FiberBoundary (ClaudeAgentSDK)
FileChangedHookInput (ClaudeAgentSDK)
FileChangedHookSpecificOutput (ClaudeAgentSDK)
FilesPersistedMessage (ClaudeAgentSDK)
ForkSessionResult (ClaudeAgentSDK)

H

HookContext (ClaudeAgentSDK)
HookMatcher (ClaudeAgentSDK)
HookProgressMessage (ClaudeAgentSDK)
HookResponseMessage (ClaudeAgentSDK)
HookStartedMessage (ClaudeAgentSDK)
Http (ClaudeAgentSDK::CLIInstaller)

I

InMemorySessionStore (ClaudeAgentSDK)
InitMessage (ClaudeAgentSDK)
InlineCancellation (ClaudeAgentSDK::FiberBoundary)
InstructionsLoadedHookInput (ClaudeAgentSDK)
Instrumentation (ClaudeAgentSDK)

J

JoinTimeout (ClaudeAgentSDK::FiberBoundary)

L

LocalCommandOutputMessage (ClaudeAgentSDK)

M

MaterializedResume (ClaudeAgentSDK)
McpClaudeAIProxyServerConfig (ClaudeAgentSDK)
McpHttpServerConfig (ClaudeAgentSDK)
McpSSEServerConfig (ClaudeAgentSDK)
McpSdkServerConfig (ClaudeAgentSDK)
McpSdkServerConfigStatus (ClaudeAgentSDK)
McpServerInfo (ClaudeAgentSDK)
McpServerStatus (ClaudeAgentSDK)
McpStatusResponse (ClaudeAgentSDK)
McpStdioServerConfig (ClaudeAgentSDK)
McpToolAnnotations (ClaudeAgentSDK)
McpToolInfo (ClaudeAgentSDK)
MessageParseError (ClaudeAgentSDK)
MessageParser (ClaudeAgentSDK)
Metadata (ClaudeAgentSDK::CLIInstaller)
MirrorErrorMessage (ClaudeAgentSDK)

N

NotificationHookInput (ClaudeAgentSDK)
NotificationHookSpecificOutput (ClaudeAgentSDK)

O

OTelObserver (ClaudeAgentSDK::Instrumentation)
Observer (ClaudeAgentSDK)
OptionWarnings (ClaudeAgentSDK)

P

PermissionDeniedHookInput (ClaudeAgentSDK)
PermissionDeniedHookSpecificOutput (ClaudeAgentSDK)
PermissionRequestHookInput (ClaudeAgentSDK)
PermissionRequestHookSpecificOutput (ClaudeAgentSDK)
PermissionResultAllow (ClaudeAgentSDK)
PermissionResultDeny (ClaudeAgentSDK)
PermissionRuleValue (ClaudeAgentSDK)
PermissionUpdate (ClaudeAgentSDK)
Platform (ClaudeAgentSDK::CLIInstaller)
PostCompactHookInput (ClaudeAgentSDK)
PostToolUseFailureHookInput (ClaudeAgentSDK)
PostToolUseFailureHookSpecificOutput (ClaudeAgentSDK)
PostToolUseHookInput (ClaudeAgentSDK)
PostToolUseHookSpecificOutput (ClaudeAgentSDK)
PreCompactHookInput (ClaudeAgentSDK)
PreToolUseHookInput (ClaudeAgentSDK)
PreToolUseHookSpecificOutput (ClaudeAgentSDK)
ProcessError (ClaudeAgentSDK)
PromptSuggestionMessage (ClaudeAgentSDK)

Q

Query (ClaudeAgentSDK)

R

RateLimitEvent (ClaudeAgentSDK)
RateLimitInfo (ClaudeAgentSDK)
Release (ClaudeAgentSDK::CLIInstaller)
ResultError (ClaudeAgentSDK)
ResultMessage (ClaudeAgentSDK)

S

SDKSessionInfo (ClaudeAgentSDK)
SandboxFilesystemConfig (ClaudeAgentSDK)
SandboxNetworkConfig (ClaudeAgentSDK)
SandboxSettings (ClaudeAgentSDK)
SdkMcpPrompt (ClaudeAgentSDK)
SdkMcpResource (ClaudeAgentSDK)
SdkMcpServer (ClaudeAgentSDK)
SdkMcpTool (ClaudeAgentSDK)
SdkPluginConfig (ClaudeAgentSDK)
ServerToolResultBlock (ClaudeAgentSDK)
ServerToolUseBlock (ClaudeAgentSDK)
SessionEndHookInput (ClaudeAgentSDK)
SessionMessage (ClaudeAgentSDK)
SessionMutations (ClaudeAgentSDK)
SessionResume (ClaudeAgentSDK)
SessionStartHookInput (ClaudeAgentSDK)
SessionStartHookSpecificOutput (ClaudeAgentSDK)
SessionStateChangedMessage (ClaudeAgentSDK)
SessionStore (ClaudeAgentSDK)
SessionStores (ClaudeAgentSDK)
SessionSummary (ClaudeAgentSDK)
Sessions (ClaudeAgentSDK)
SetupHookInput (ClaudeAgentSDK)
SetupHookSpecificOutput (ClaudeAgentSDK)
StatusMessage (ClaudeAgentSDK)
StopFailureHookInput (ClaudeAgentSDK)
StopHookInput (ClaudeAgentSDK)
StreamEvent (ClaudeAgentSDK)
Streaming (ClaudeAgentSDK)
SubagentStartHookInput (ClaudeAgentSDK)
SubagentStartHookSpecificOutput (ClaudeAgentSDK)
SubagentStopHookInput (ClaudeAgentSDK)
SubprocessCLITransport (ClaudeAgentSDK)
SyncHookJSONOutput (ClaudeAgentSDK)
SystemMessage (ClaudeAgentSDK)
SystemPromptFile (ClaudeAgentSDK)
SystemPromptPreset (ClaudeAgentSDK)

T

TaskBudget (ClaudeAgentSDK)
TaskCompletedHookInput (ClaudeAgentSDK)
TaskCreatedHookInput (ClaudeAgentSDK)
TaskNotificationMessage (ClaudeAgentSDK)
TaskProgressMessage (ClaudeAgentSDK)
TaskStartedMessage (ClaudeAgentSDK)
TaskUpdatedMessage (ClaudeAgentSDK)
TaskUsage (ClaudeAgentSDK)
TeammateIdleHookInput (ClaudeAgentSDK)
Testing (ClaudeAgentSDK)
TextBlock (ClaudeAgentSDK)
ThinkingBlock (ClaudeAgentSDK)
ThinkingConfigAdaptive (ClaudeAgentSDK)
ThinkingConfigDisabled (ClaudeAgentSDK)
ThinkingConfigEnabled (ClaudeAgentSDK)
ThreadWaiter (ClaudeAgentSDK::Query)
ToolPermissionContext (ClaudeAgentSDK)
ToolProgressMessage (ClaudeAgentSDK)
ToolResultBlock (ClaudeAgentSDK)
ToolUseBlock (ClaudeAgentSDK)
ToolUseSummaryMessage (ClaudeAgentSDK)
ToolsPreset (ClaudeAgentSDK)
TranscriptMirrorBatcher (ClaudeAgentSDK)
Transport (ClaudeAgentSDK)
Type (ClaudeAgentSDK)

U

UnknownBlock (ClaudeAgentSDK)
UnknownHookInput (ClaudeAgentSDK)
UserMessage (ClaudeAgentSDK)
UserPromptSubmitHookInput (ClaudeAgentSDK)
UserPromptSubmitHookSpecificOutput (ClaudeAgentSDK)

W

WorktreeCreateHookInput (ClaudeAgentSDK)
WorktreeRemoveHookInput (ClaudeAgentSDK)