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. |
| AgentOutputTokensDetails | Represents a breakdown of the output tokens used by an agent. |
| 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. |
| AgentToolStats | Represents an aggregate breakdown of the tools used by an Agent during its execution. |
| AgentUsageInfo | Contains token usage information for a completed agent execution, including input/output token counts, cache statistics, and server-side tool use. |
| ArtifactAssetDelete | Represents the result of the Artifact tool’s delete_asset action. |
| ArtifactAssetInfo | Represents an asset in an artifact’s asset store. |
| ArtifactAssetList | Represents the result of the Artifact tool’s list_assets action. |
| ArtifactAssetRead | Represents the result of the Artifact tool’s read_asset action. |
| ArtifactAssetUpload | Represents an asset uploaded to an artifact. |
| ArtifactAssetUploadBatch | Represents the result of uploading several assets to an artifact. |
| ArtifactAssetUploadResult | Represents the result of uploading one file in a batch. |
| ArtifactAssetUsage | Represents the usage and limits of an artifact’s asset store. |
| ArtifactListItem | Represents an artifact returned by the Artifact tool’s list action. |
| ArtifactPinResult | Represents the result of the Artifact tool’s pin and unpin actions. |
| ArtifactReadInfo | Represents an artifact source and the version of it that now counts as viewed. |
| ArtifactReadResult | Represents the content returned by the Artifact tool’s read action. |
| ArtifactStoredDeclaration | Represents the capability declaration stored on an artifact. |
| ArtifactToolResponse | Represents the response payload returned by the Artifact tool. |
| ArtifactUnwatchResult | Represents the result of the Artifact tool’s unwatch action. |
| ArtifactWatchArm | Represents the connection state of an artifact watch. |
| ArtifactWatchEntry | Represents one watch returned by the Artifact tool’s status action. |
| ArtifactWatchResult | Represents the result of the Artifact tool’s watch action. |
| ArtifactWrittenInfo | Represents the artifact written by an asset action. |
| 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. |
| ClaudeDesignToolResponse | Represents the response payload returned by the ClaudeDesign tool. |
| CompletedAgentToolResponse | Represents the Agent tool response when the agent completed its work synchronously and returned its results inline. |
| CreatedTaskInfo | Represents a task created by the TaskCreate tool. |
| CronCreateToolResponse | Represents the response payload returned by the CronCreate tool. |
| CronDeleteToolResponse | Represents the response payload returned by the CronDelete tool. |
| CronJobInfo | Represents a scheduled job returned by the CronList tool. |
| CronListToolResponse | Represents the response payload returned by the CronList tool. |
| DeleteProjectsToolResponse | Represents the Projects tool response for the project_delete method. |
| 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. |
| EnterPlanModeToolResponse | Represents the response payload returned by the EnterPlanMode tool. |
| 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. |
| GitBranchOperationInfo | Represents a branch integration detected in a Bash command. |
| GitCommitInfo | Represents a commit detected in a Bash command. |
| GitDiffInfo | Represents git diff information for a file change, including additions, deletions, and the unified diff patch. |
| GitOperationInfo | Represents the git and GitHub operations detected in a Bash command. |
| GitPullRequestInfo | Represents a pull request operation detected in a Bash command. |
| GitPushInfo | Represents a push detected in a Bash command. |
| 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). |
| InfoProjectsToolResponse | Represents the Projects tool response for the project_info method. |
| McpContentBlock | Represents a content block returned by an MCP tool. |
| McpDirectoryResourceInfo | Represents a child of an MCP directory resource. |
| 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. |
| McpToolResponse | Represents the result of an MCP tool execution. |
| MemoryListProjectsToolResponse | Represents the Projects tool response for the project_memory_list method. |
| MemoryReadProjectsToolResponse | Represents the Projects tool response for the project_memory_read method. |
| MonitorToolResponse | Represents the response payload returned by the Monitor 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. |
| OfferChromeSetupToolResponse | Represents the response payload returned by the OfferChromeSetup tool. |
| PartsReadPage | Represents a page image extracted from a PDF by the Read tool. |
| 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. |
| ProjectDocumentInfo | Represents a document in a project. |
| ProjectFileInfo | Represents a file in a project. |
| ProjectKnowledgeInfo | Represents the knowledge-base capacity of a project. |
| ProjectMemoryFileInfo | Represents a project memory file. |
| ProjectSearchHit | Represents a project knowledge-base search hit. |
| ProjectsToolResponse | Represents the response payload returned by the Projects tool. |
| ProjectSyncSource | Represents a source synchronized into a project. |
| ProposeGoalToolResponse | Represents the response payload returned by the ProposeGoal tool. |
| ProposeSkillsToolResponse | Represents the response payload returned by the ProposeSkills tool. |
| PushNotificationToolResponse | Represents the response payload returned by the PushNotification tool. |
| ReadMcpResourceDirToolResponse | Represents the response payload returned by the ReadMcpResourceDir tool. |
| ReadMcpResourceToolResponse | Represents the response payload returned by the Claude Code ReadMcpResource tool after reading the content of an MCP (Model Context Protocol) resource. |
| ReadNotificationsToolResponse | Represents the response payload returned by the ReadNotifications tool. |
| ReadProjectsToolResponse | Represents the Projects tool response for the project_read method. |
| 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. |
| RefreshMcpToolsServerResult | Represents the result of refreshing the tool list of a single MCP server. |
| RemoteLaunchedAgentToolResponse | Represents the Agent tool response when the agent was launched in a remote cloud environment. |
| RemoteTriggerToolResponse | Represents the response payload returned by the RemoteTrigger tool. |
| ReportFindingsToolResponse | Represents the response payload returned by the ReportFindings tool. |
| ScheduleWakeupToolResponse | Represents the response payload returned by the ScheduleWakeup tool. |
| SearchProjectsToolResponse | Represents the Projects tool response for the project_search method. |
| SendFeedbackToolResponse | Represents the response payload returned by the SendFeedback tool. |
| SessionNotification | Represents a notification delivered to a session. |
| ShowOnboardingRolePickerToolResponse | Represents the response payload returned by the ShowOnboardingRolePicker tool. |
| TaskCreateToolResponse | Represents the response payload returned by the TaskCreate tool. |
| TaskDetailInfo | Represents the details of a task returned by the TaskGet tool. |
| TaskGetToolResponse | Represents the response payload returned by the TaskGet tool. |
| TaskListItem | Represents a task returned by the TaskList tool. |
| TaskListToolResponse | Represents the response payload returned by the TaskList tool. |
| TaskStatusChange | Represents a task’s status transition. |
| TaskStopToolResponse | Represents the response payload returned by the Claude Code TaskStop tool after stopping a running background task. |
| TaskUpdateToolResponse | Represents the response payload returned by the TaskUpdate tool. |
| 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. |
| WorkflowToolResponse | Represents the response payload returned by the Workflow tool. |
| WriteProjectsToolResponse | Represents the Projects tool response for the project_write method. |
| WriteToolResponse | Represents the response payload returned by the Claude Code Write tool after creating or overwriting a file. |