Package-level declarations

Types

Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class BashCodeExecutionContent
Link copied to clipboard
@JsonSerializable
data class BashCodeExecutionOutput(val file_id: FileId, val type: String = "bash_code_execution_output")
Link copied to clipboard
@JsonSerializable
data class BatchRequest(val custom_id: CustomId, val params: MessageCompletion)
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class BatchResult
Link copied to clipboard
@JsonSerializable
data class CacheControl(val ttl: CacheTtl? = null, val type: String = "ephemeral")
Link copied to clipboard
@JsonSerializable
data class CacheCreation(val ephemeral_5m_input_tokens: Int? = null, val ephemeral_1h_input_tokens: Int? = null)
Link copied to clipboard
Link copied to clipboard
enum Caller : Enum<Caller>
Link copied to clipboard
@JsonSerializable
data class CapabilitySupport(val supported: Boolean)
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class Citation
Link copied to clipboard
@JsonSerializable
data class Citations(val enabled: Boolean)
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class CodeExecutionContent
Link copied to clipboard
@JsonSerializable
data class CodeExecutionOutput(val file_id: FileId, val type: String = "code_execution_output")
Link copied to clipboard
@JsonSerializable
data class Container(val id: ContainerId, val expires_at: Instant? = null)
Link copied to clipboard
class ContainerId : AbstractValue<String> , ContainerSpec
Link copied to clipboard
@JsonSerializable
data class ContainerParams(val skills: List<Skill> = emptyList()) : ContainerSpec
Link copied to clipboard
sealed interface ContainerSpec
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class Content
Link copied to clipboard
@JsonSerializable
data class ContextManagementCapability(val supported: Boolean, val clear_tool_uses_20250919: CapabilitySupport? = null, val clear_thinking_20251015: CapabilitySupport? = null, val compact_20260112: CapabilitySupport? = null)
Link copied to clipboard
@JsonSerializable
data class CountTokens(val model: ModelName, val messages: List<Message>, val system: List<Content.Text>? = null, val tools: List<Tool> = emptyList(), val tool_choice: ToolChoice? = null, val thinking: Thinking? = null, val output_config: OutputConfig? = null, val cache_control: CacheControl? = null) : NonNullAutoMarshalledAction<TokenCount> , AnthropicAIAction<TokenCount>
Link copied to clipboard
@JsonSerializable
data class CountTokensContextManagement(val original_input_tokens: Int)
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class DeletedFile(val id: FileId, val type: String = "file_deleted")
Link copied to clipboard
@JsonSerializable
data class DeletedMessageBatch(val id: MessageBatchId, val type: String = "message_batch_deleted")
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class DeltaContent
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class DocumentSource
Link copied to clipboard
Link copied to clipboard
enum Effort : Enum<Effort>
Link copied to clipboard
@JsonSerializable
data class EffortCapability(val supported: Boolean, val low: CapabilitySupport? = null, val medium: CapabilitySupport? = null, val high: CapabilitySupport? = null, val xhigh: CapabilitySupport? = null, val max: CapabilitySupport? = null)
Link copied to clipboard
@JsonSerializable
data class ErrorDetail(val type: ErrorCode, val message: String)
Link copied to clipboard
@JsonSerializable
data class FileMetadata(val id: FileId, val filename: FileName, val mime_type: MimeType, val size_bytes: Long, val created_at: Instant, val downloadable: Boolean = false, val expires_at: Instant? = null, val scope: FileScope? = null, val type: String = "file")
Link copied to clipboard
@JsonSerializable
data class Files(val data: List<FileMetadata>, val next_page: String? = null) : Paged<String, FileMetadata>
Link copied to clipboard
@JsonSerializable
data class FileScope(val type: String, val id: String)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class GetModels(val limit: Int? = null, val after_id: String? = null, val before_id: String? = null) : NonNullAutoMarshalledAction<Models> , AnthropicAIAction<Models> , PagedAction<String, ModelInfo, Models, GetModels>
Link copied to clipboard
@JsonSerializable
data class ImageTransformations(val oversized_image: OversizedImage? = null)
Link copied to clipboard
class InferenceGeo : AbstractValue<String>
Link copied to clipboard
data class ListFiles(val limit: Int? = null, val page: String? = null, val ids: List<FileId> = emptyList(), val scope_id: String? = null) : NonNullAutoMarshalledAction<Files> , AnthropicAIAction<Files> , PagedAction<String, FileMetadata, Files, ListFiles>
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class Message(val role: Role, val content: List<Content>)
Link copied to clipboard
@JsonSerializable
data class MessageBatch(val id: MessageBatchId, val processing_status: ProcessingStatus, val request_counts: RequestCounts, val created_at: Instant, val expires_at: Instant, val results_url: Uri? = null, val ended_at: Instant? = null, val archived_at: Instant? = null, val cancel_initiated_at: Instant? = null, val type: String = "message_batch")
Link copied to clipboard
@JsonSerializable
data class MessageBatches(val data: List<MessageBatch>, val has_more: Boolean = false, val first_id: String? = null, val last_id: String? = null) : Paged<String, MessageBatch>
Link copied to clipboard
@JsonSerializable
data class MessageBatchResponse(val custom_id: CustomId, val result: BatchResult)
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class MessageCompletionResponse(val id: ResponseId, val role: Role, val content: List<Content>, val model: ModelName, val stop_reason: StopReason?, val stop_sequence: String?, val usage: Usage, val stop_details: RefusalDetails? = null, val container: Container? = null, val type: String = "message")
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class MessageDeltaContent(val stop_reason: StopReason?, val stop_sequence: String?, val usage: Usage?)
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class MessageGenerationEvent
Link copied to clipboard
@JsonSerializable
data class Metadata(val user_id: UserId?)
Link copied to clipboard
@JsonSerializable
data class ModelCapabilities(val batch: CapabilitySupport? = null, val citations: CapabilitySupport? = null, val code_execution: CapabilitySupport? = null, val image_input: CapabilitySupport? = null, val pdf_input: CapabilitySupport? = null, val structured_outputs: CapabilitySupport? = null, val context_management: ContextManagementCapability? = null, val effort: EffortCapability? = null, val thinking: ThinkingCapability? = null)
Link copied to clipboard
@JsonSerializable
data class ModelInfo(val id: ModelName, val display_name: String, val created_at: Instant, val max_input_tokens: Int? = null, val max_tokens: Int? = null, val capabilities: ModelCapabilities? = null, val type: String = "model")
Link copied to clipboard
@JsonSerializable
data class Models(val data: List<ModelInfo>, val has_more: Boolean = false, val first_id: String? = null, val last_id: String? = null) : Paged<String, ModelInfo>
Link copied to clipboard
@JsonSerializable
data class OutputConfig(val effort: Effort? = null, val format: OutputFormat? = null)
Link copied to clipboard
@JsonSerializable
data class OutputFormat(val schema: Map<String, Any>, val type: String = "json_schema")
Link copied to clipboard
@JsonSerializable
data class OutputTokensDetails(val thinking_tokens: Int? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class RefusalDetails(val category: RefusalCategory? = null, val explanation: String? = null, val type: String = "refusal")
Link copied to clipboard
@JsonSerializable
data class RequestCounts(val processing: Int = 0, val succeeded: Int = 0, val errored: Int = 0, val canceled: Int = 0, val expired: Int = 0)
Link copied to clipboard
@JsonSerializable
data class ServerToolUsage(val web_search_requests: Int? = null, val web_fetch_requests: Int? = null)
Link copied to clipboard
Link copied to clipboard
@JsonSerializable
data class Skill(val skill_id: SkillId, val version: String? = null, val type: String = "anthropic")
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class Source
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class TextEditorCodeExecutionContent
Link copied to clipboard
@JsonSerializable
data class ThinkingCapability(val supported: Boolean, val types: ThinkingTypes? = null)
Link copied to clipboard
@JsonSerializable
data class ThinkingTypes(val adaptive: CapabilitySupport? = null, val enabled: CapabilitySupport? = null)
Link copied to clipboard
@JsonSerializable
data class TokenCount(val input_tokens: Int, val context_management: CountTokensContextManagement? = null)
Link copied to clipboard
sealed class Tool
Link copied to clipboard
@JsonSerializable
data class ToolCaller(val type: Caller, val tool_id: String? = null)
Link copied to clipboard
@JsonSerializable
data class ToolConfig(val name: String, val enabled: Boolean? = null, val defer_loading: Boolean? = null)
Link copied to clipboard
@JsonSerializable
data class ToolReference(val tool_name: ToolName, val type: String = "tool_reference")
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class ToolSearchContent
Link copied to clipboard
data class UploadFile(val filename: FileName, val content: InputStream, val contentType: ContentType = OCTET_STREAM, val expires_in_seconds: Long? = null) : NonNullAutoMarshalledAction<FileMetadata> , AnthropicAIAction<FileMetadata>
Link copied to clipboard
@JsonSerializable
data class Usage(val input_tokens: Int? = null, val cache_creation_input_tokens: Int? = null, val cache_read_input_tokens: Int? = null, val output_tokens: Int? = null, val cache_creation: CacheCreation? = null, val output_tokens_details: OutputTokensDetails? = null, val server_tool_use: ServerToolUsage? = null, val service_tier: UsageServiceTier? = null, val inference_geo: InferenceGeo? = null)
Link copied to clipboard
class UsageServiceTier : AbstractValue<String>
Link copied to clipboard
@JsonSerializable
data class UserLocation(val city: String? = null, val region: String? = null, val country: String? = null, val timezone: String? = null, val type: String = "approximate")
Link copied to clipboard
@JsonSerializable
@Polymorphic(labelKey = "type")
sealed class WebFetchContent
Link copied to clipboard
sealed interface WebSearchContent
Link copied to clipboard
@JsonSerializable
data class WebSearchFailed(val error_code: ErrorCode, val type: String = "web_search_tool_result_error") : WebSearchContent
Link copied to clipboard
@JsonSerializable
data class WebSearchResult(val url: Uri, val title: String? = null, val page_age: String? = null, val encrypted_content: String? = null, val type: String = "web_search_result")
Link copied to clipboard
@JsonSerializable
data class WebSearchResults(val results: List<WebSearchResult>) : WebSearchContent

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Tool.Companion.textEditor(maxCharacters: Int? = null): Tool.BuiltIn
Link copied to clipboard
Link copied to clipboard
fun Tool.Companion.webFetch(maxUses: Int? = null, maxContentTokens: Int? = null, citations: Citations? = null, allowedDomains: List<String>? = null, blockedDomains: List<String>? = null, useCache: Boolean? = null, responseInclusion: String? = null): Tool.BuiltIn
Link copied to clipboard
fun Tool.Companion.webSearch(maxUses: Int? = null, allowedDomains: List<String>? = null, blockedDomains: List<String>? = null, userLocation: UserLocation? = null, responseInclusion: String? = null): Tool.BuiltIn