Module types

Module types 

Source
Expand description

Core types for the Claude Agent SDK.

Re-exports§

pub use crate::models::DEFAULT_COMPACT_THRESHOLD;
pub use crate::models::context_window;
pub use citations::CharLocationCitation;
pub use citations::Citation;
pub use citations::CitationsConfig;
pub use citations::ContentBlockLocationCitation;
pub use citations::PageLocationCitation;
pub use citations::SearchResultLocationCitation;
pub use content::ContentBlock;
pub use content::ImageSource;
pub use content::ServerToolError;
pub use content::ServerToolUseBlock;
pub use content::TextBlock;
pub use content::ThinkingBlock;
pub use content::ToolResultBlock;
pub use content::ToolResultContent;
pub use content::ToolResultContentBlock;
pub use content::ToolUseBlock;
pub use content::WebFetchResultItem;
pub use content::WebFetchToolResultBlock;
pub use content::WebFetchToolResultContent;
pub use content::WebSearchResultItem;
pub use content::WebSearchToolResultBlock;
pub use content::WebSearchToolResultContent;
pub use document::DocumentBlock;
pub use document::DocumentContentBlock;
pub use document::DocumentSource;
pub use search::SearchResultBlock;
pub use search::SearchResultContentBlock;

Modules§

citations
Citation types for document-based responses.
content
Content block types for messages.
document
Document content block types for citations.
search
Search result content block for web search citations.

Structs§

ApiResponse
CacheControl
Cache control for prompt caching.
Message
A message in a conversation
MessageDeltaData
MessageStartData
ModelUsage
Per-model usage statistics tracking.
PermissionDenial
Record of a permission denial for a tool request.
ServerToolUse
Server-side tool usage statistics.
ServerToolUseUsage
Server-side tool usage from API response.
StreamError
SystemBlock
A block in a structured system prompt.
TokenUsage
ToolDefinition
ToolInput
ToolReference
ToolResult
ToolSearchResult
ToolSearchToolResult
Usage
UserLocation
WebFetchTool
WebSearchTool

Enums§

CacheTtl
CacheType
CompactResult
ContentDelta
Role
Role of a message participant
ServerTool
StopReason
StreamEvent
SystemPrompt
System prompt configuration
ToolError
ToolOutput
ToolOutputBlock
ToolSearchErrorCode
ToolSearchResultContent
ToolSearchTool