Types
Classes
| Name | Summary |
|---|---|
| AgentCacheCreationInfo | Contains cache creation token counts for an agent execution, broken down by ephemeral cache duration. |
| AgentContentBlock | Represents a content block in an agent’s response, containing text output. |
| AgentServerToolUseInfo | Contains server-side tool use counts for an agent execution, tracking how many web search and web fetch requests were made. |
| AgentToolResponse | Represents the response payload returned by the Claude Code Agent tool. This is a polymorphic base type — the actual response will be either CompletedAgentToolResponse or AsyncLaunchedAgentToolResponse depending on whether the agent ran synchronously or was launched in the background. |
| AgentUsageInfo | Contains token usage information for a completed agent execution, including input/output token counts, cache statistics, and server-side tool use. |
| AskUserQuestionAnnotation | Represents per-question annotations from the user in an AskUserQuestion response, such as notes on preview selections. |
| AskUserQuestionToolResponse | Represents the response payload returned by the Claude Code AskUserQuestion tool after the user has answered the presented questions. |
| AsyncLaunchedAgentToolResponse | Represents the Agent tool response when the agent was launched in the background and has not yet completed. |
| BashToolResponse | Represents the response payload returned by the Claude Code Bash tool after executing a shell command. |
| CompletedAgentToolResponse | Represents the Agent tool response when the agent completed its work synchronously and returned its results inline. |
| ConfigToolResponse | Represents the response payload returned by the Claude Code Config tool after getting or setting a configuration value. |
| EditToolResponse | Represents the response payload returned by the Claude Code Edit tool after performing a string replacement in a file. |
| StructuredPatchHunk | Represents a single hunk (contiguous block of changes) in a unified diff patch. |
| EnterWorktreeToolResponse | Represents the response payload returned by the Claude Code EnterWorktree tool after creating a temporary git worktree. |
| ExitPlanModeToolResponse | Represents the response payload returned by the Claude Code ExitPlanMode tool after transitioning from plan mode to execution mode. |
| ExitWorktreeToolResponse | Represents the response payload returned by the Claude Code ExitWorktree tool after exiting and optionally removing a git worktree. |
| FileUnchangedReadToolFileInfo | Contains information about a file that was unchanged since it was last read. |
| FileUnchangedReadToolResponse | Represents the Read tool response when a file has not changed since it was last read. |
| GitDiffInfo | Represents git diff information for a file change, including additions, deletions, and the unified diff patch. |
| GlobToolResponse | Represents the response payload returned by the Claude Code Glob tool after searching for files matching a pattern. |
| GrepToolResponse | Represents the response payload returned by the Claude Code Grep tool after searching for content within files. |
| ImageDimensionInfo | Contains image dimension information for coordinate mapping, including both original and displayed sizes after any resizing. |
| ImageReadToolFileInfo | Contains information about an image file read by the Claude Code Read tool, including base64-encoded data, MIME type, and dimension metadata. |
| ImageReadToolResponse | Represents the Read tool response for an image file (PNG, JPG, GIF, WebP). |
| KillShellToolResponse | Represents the response payload returned by the Claude Code KillShell tool after attempting to terminate a background shell process. |
| ListMcpResourcesToolResponse | Represents the response payload returned by the Claude Code ListMcpResources tool after listing available MCP (Model Context Protocol) resources. |
| McpResourceContent | Represents the content of a single MCP (Model Context Protocol) resource as returned by the ReadMcpResource tool. |
| McpResourceInfo | Represents a single MCP (Model Context Protocol) resource entry returned by the ListMcpResources tool. |
| NotebookEditToolResponse | Represents the response payload returned by the Claude Code NotebookEdit tool after modifying a Jupyter notebook cell. |
| NotebookReadToolFileInfo | Contains information about a Jupyter notebook file read by the Claude Code Read tool. |
| NotebookReadToolResponse | Represents the Read tool response for a Jupyter notebook (.ipynb) file. |
| PartsReadToolFileInfo | Contains information about a PDF file read in parts by the Claude Code Read tool, where individual pages are extracted as images. |
| PartsReadToolResponse | Represents the Read tool response for a PDF file that was split into individual page images. |
| PdfReadToolFileInfo | Contains information about a PDF file read by the Claude Code Read tool, including base64-encoded data and file size. |
| PdfReadToolResponse | Represents the Read tool response for a PDF file. |
| ReadMcpResourceToolResponse | Represents the response payload returned by the Claude Code ReadMcpResource tool after reading the content of an MCP (Model Context Protocol) resource. |
| ReadToolFileInfo | Contains detailed information about a text file read by the Claude Code Read tool, including its path, content, and line-related metadata. |
| ReadToolResponse | Represents the base response payload returned by the Claude Code Read tool after reading a file. |
| TaskStopToolResponse | Represents the response payload returned by the Claude Code TaskStop tool after stopping a running background task. |
| TaskToolResponse | Represents the response payload returned by the Claude Code Task tool after executing a subagent to handle a complex task. |
| TextReadToolResponse | Represents the Read tool response for a standard text file. |
| TodoWriteToolResponse | Represents the response payload returned by the Claude Code TodoWrite tool after updating the task list. |
| WebFetchToolResponse | Represents the response payload returned by the Claude Code WebFetch tool after fetching and processing content from a URL. |
| WebSearchToolResponse | Represents the response payload returned by the Claude Code WebSearch tool after performing a web search. |
| WebSearchResultContainer | Represents a container grouping web search results from a single search operation. |
| WebSearchResultItem | Represents an individual web search result with a title and URL. |
| WriteToolResponse | Represents the response payload returned by the Claude Code Write tool after creating or overwriting a file. |