Shared Types

fromanthropic.typesimport (
APIErrorObject,
AuthenticationError,
BillingError,
ErrorObject,
ErrorResponse,
ErrorType,
GatewayTimeoutError,
InvalidRequestError,
NotFoundError,
OverloadedError,
PermissionError,
RateLimitError,
)

Messages

Types:

fromanthropic.typesimport (
Base64ImageSource,
Base64PDFSource,
BashCodeExecutionOutputBlock,
BashCodeExecutionOutputBlockParam,
BashCodeExecutionResultBlock,
BashCodeExecutionResultBlockParam,
BashCodeExecutionToolResultBlock,
BashCodeExecutionToolResultBlockParam,
BashCodeExecutionToolResultError,
BashCodeExecutionToolResultErrorCode,
BashCodeExecutionToolResultErrorParam,
CacheControlEphemeral,
CacheCreation,
CitationCharLocation,
CitationCharLocationParam,
CitationContentBlockLocation,
CitationContentBlockLocationParam,
CitationPageLocation,
CitationPageLocationParam,
CitationSearchResultLocationParam,
CitationWebSearchResultLocationParam,
CitationsConfig,
CitationsConfigParam,
CitationsDelta,
CitationsSearchResultLocation,
CitationsWebSearchResultLocation,
CodeExecutionOutputBlock,
CodeExecutionOutputBlockParam,
CodeExecutionResultBlock,
CodeExecutionResultBlockParam,
CodeExecutionTool20250522,
CodeExecutionTool20250825,
CodeExecutionTool20260120,
CodeExecutionTool20260521,
CodeExecutionToolResultBlock,
CodeExecutionToolResultBlockContent,
CodeExecutionToolResultBlockParam,
CodeExecutionToolResultBlockParamContent,
CodeExecutionToolResultError,
CodeExecutionToolResultErrorCode,
CodeExecutionToolResultErrorParam,
Container,
ContainerUploadBlock,
ContainerUploadBlockParam,
ContentBlock,
ContentBlockParam,
ContentBlockSource,
ContentBlockSourceContent,
DirectCaller,
DocumentBlock,
DocumentBlockParam,
EncryptedCodeExecutionResultBlock,
EncryptedCodeExecutionResultBlockParam,
ImageBlockParam,
InputJSONDelta,
JSONOutputFormat,
MemoryTool20250818,
Message,
MessageCountTokensTool,
MessageDeltaUsage,
MessageParam,
MessageTokensCount,
Metadata,
MidConversationSystemBlockParam,
Model,
OutputConfig,
OutputTokensDetails,
PlainTextSource,
RawContentBlockDelta,
RawContentBlockDeltaEvent,
RawContentBlockStartEvent,
RawContentBlockStopEvent,
RawMessageDeltaEvent,
RawMessageStartEvent,
RawMessageStopEvent,
RawMessageStreamEvent,
RedactedThinkingBlock,
RedactedThinkingBlockParam,
RefusalStopDetails,
SearchResultBlockParam,
ServerToolCaller,
ServerToolCaller20260120,
ServerToolUsage,
ServerToolUseBlock,
ServerToolUseBlockParam,
SignatureDelta,
StopReason,
TextBlock,
TextBlockParam,
TextCitation,
TextCitationParam,
TextDelta,
TextEditorCodeExecutionCreateResultBlock,
TextEditorCodeExecutionCreateResultBlockParam,
TextEditorCodeExecutionStrReplaceResultBlock,
TextEditorCodeExecutionStrReplaceResultBlockParam,
TextEditorCodeExecutionToolResultBlock,
TextEditorCodeExecutionToolResultBlockParam,
TextEditorCodeExecutionToolResultError,
TextEditorCodeExecutionToolResultErrorCode,
TextEditorCodeExecutionToolResultErrorParam,
TextEditorCodeExecutionViewResultBlock,
TextEditorCodeExecutionViewResultBlockParam,
ThinkingBlock,
ThinkingBlockParam,
ThinkingConfigAdaptive,
ThinkingConfigDisabled,
ThinkingConfigEnabled,
ThinkingConfigParam,
ThinkingDelta,
Tool,
ToolBash20250124,
ToolChoice,
ToolChoiceAny,
ToolChoiceAuto,
ToolChoiceNone,
ToolChoiceTool,
ToolReferenceBlock,
ToolReferenceBlockParam,
ToolResultBlockParam,
ToolSearchToolBm25_20251119,
ToolSearchToolRegex20251119,
ToolSearchToolResultBlock,
ToolSearchToolResultBlockParam,
ToolSearchToolResultError,
ToolSearchToolResultErrorCode,
ToolSearchToolResultErrorParam,
ToolSearchToolSearchResultBlock,
ToolSearchToolSearchResultBlockParam,
ToolTextEditor20250124,
ToolTextEditor20250429,
ToolTextEditor20250728,
ToolUnion,
ToolUseBlock,
ToolUseBlockParam,
URLImageSource,
URLPDFSource,
Usage,
UserLocation,
WebFetchBlock,
WebFetchBlockParam,
WebFetchTool20250910,
WebFetchTool20260209,
WebFetchTool20260309,
WebFetchTool20260318,
WebFetchToolResultBlock,
WebFetchToolResultBlockParam,
WebFetchToolResultErrorBlock,
WebFetchToolResultErrorBlockParam,
WebFetchToolResultErrorCode,
WebSearchResultBlock,
WebSearchResultBlockParam,
WebSearchTool20250305,
WebSearchTool20260209,
WebSearchTool20260318,
WebSearchToolRequestError,
WebSearchToolResultBlock,
WebSearchToolResultBlockContent,
WebSearchToolResultBlockParam,
WebSearchToolResultBlockParamContent,
WebSearchToolResultError,
WebSearchToolResultErrorCode,
MessageStreamEvent,
MessageStartEvent,
MessageDeltaEvent,
MessageStopEvent,
ContentBlockStartEvent,
ContentBlockDeltaEvent,
ContentBlockStopEvent,
)

Methods:

client.messages.create(**params) -> Message
client.messages.stream(*args) -> MessageStreamManager[MessageStream] | MessageStreamManager[MessageStreamT]
client.messages.count_tokens(**params) -> MessageTokensCount

Batches

Types:

fromanthropic.types.messagesimport (
DeletedMessageBatch,
MessageBatch,
MessageBatchCanceledResult,
MessageBatchErroredResult,
MessageBatchExpiredResult,
MessageBatchIndividualResponse,
MessageBatchRequestCounts,
MessageBatchResult,
MessageBatchSucceededResult,
)

Methods:

client.messages.batches.create(**params) -> MessageBatch
client.messages.batches.retrieve(message_batch_id) -> MessageBatch
client.messages.batches.list(**params) -> SyncPage[MessageBatch]
client.messages.batches.delete(message_batch_id) -> DeletedMessageBatch
client.messages.batches.cancel(message_batch_id) -> MessageBatch
client.messages.batches.results(message_batch_id) -> JSONLDecoder[MessageBatchIndividualResponse]

Models

Types:

fromanthropic.typesimport (
CapabilitySupport,
ContextManagementCapability,
EffortCapability,
ModelCapabilities,
ModelInfo,
ThinkingCapability,
ThinkingTypes,
)

Methods:

client.models.retrieve(model_id) -> ModelInfo
client.models.list(**params) -> SyncPage[ModelInfo]

Beta

Types:

fromanthropic.typesimport (
AnthropicBeta,
BetaAPIError,
BetaAuthenticationError,
BetaBillingError,
BetaError,
BetaErrorResponse,
BetaGatewayTimeoutError,
BetaInvalidRequestError,
BetaNotFoundError,
BetaOverloadedError,
BetaPermissionError,
BetaRateLimitError,
)

Models

Types:

fromanthropic.types.betaimport (
BetaCapabilitySupport,
BetaContextManagementCapability,
BetaEffortCapability,
BetaModelCapabilities,
BetaModelInfo,
BetaThinkingCapability,
BetaThinkingTypes,
)

Methods:

client.beta.models.retrieve(model_id) -> BetaModelInfo
client.beta.models.list(**params) -> SyncPage[BetaModelInfo]

Messages

Types:

fromanthropic.types.betaimport (
BetaAdvisorMessageIterationUsage,
BetaAdvisorRedactedResultBlock,
BetaAdvisorRedactedResultBlockParam,
BetaAdvisorResultBlock,
BetaAdvisorResultBlockParam,
BetaAdvisorTool20260301,
BetaAdvisorToolResultBlock,
BetaAdvisorToolResultBlockParam,
BetaAdvisorToolResultError,
BetaAdvisorToolResultErrorParam,
BetaAllThinkingTurns,
BetaBase64ImageSource,
BetaBase64PDFSource,
BetaBashCodeExecutionOutputBlock,
BetaBashCodeExecutionOutputBlockParam,
BetaBashCodeExecutionResultBlock,
BetaBashCodeExecutionResultBlockParam,
BetaBashCodeExecutionToolResultBlock,
BetaBashCodeExecutionToolResultBlockParam,
BetaBashCodeExecutionToolResultError,
BetaBashCodeExecutionToolResultErrorParam,
BetaCacheControlEphemeral,
BetaCacheCreation,
BetaCacheMissMessagesChanged,
BetaCacheMissModelChanged,
BetaCacheMissPreviousMessageNotFound,
BetaCacheMissSystemChanged,
BetaCacheMissToolsChanged,
BetaCacheMissUnavailable,
BetaCitationCharLocation,
BetaCitationCharLocationParam,
BetaCitationConfig,
BetaCitationContentBlockLocation,
BetaCitationContentBlockLocationParam,
BetaCitationPageLocation,
BetaCitationPageLocationParam,
BetaCitationSearchResultLocation,
BetaCitationSearchResultLocationParam,
BetaCitationWebSearchResultLocationParam,
BetaCitationsConfigParam,
BetaCitationsDelta,
BetaCitationsWebSearchResultLocation,
BetaClearThinking20251015Edit,
BetaClearThinking20251015EditResponse,
BetaClearToolUses20250919Edit,
BetaClearToolUses20250919EditResponse,
BetaCodeExecutionOutputBlock,
BetaCodeExecutionOutputBlockParam,
BetaCodeExecutionResultBlock,
BetaCodeExecutionResultBlockParam,
BetaCodeExecutionTool20250522,
BetaCodeExecutionTool20250825,
BetaCodeExecutionTool20260120,
BetaCodeExecutionTool20260521,
BetaCodeExecutionToolResultBlock,
BetaCodeExecutionToolResultBlockContent,
BetaCodeExecutionToolResultBlockParam,
BetaCodeExecutionToolResultBlockParamContent,
BetaCodeExecutionToolResultError,
BetaCodeExecutionToolResultErrorCode,
BetaCodeExecutionToolResultErrorParam,
BetaCompact20260112Edit,
BetaCompactionBlock,
BetaCompactionBlockParam,
BetaCompactionContentBlockDelta,
BetaCompactionIterationUsage,
BetaContainer,
BetaContainerParams,
BetaContainerUploadBlock,
BetaContainerUploadBlockParam,
BetaContentBlock,
BetaContentBlockParam,
BetaContentBlockSource,
BetaContentBlockSourceContent,
BetaContextManagementConfig,
BetaContextManagementResponse,
BetaCountTokensContextManagementResponse,
BetaDiagnostics,
BetaDiagnosticsParam,
BetaDirectCaller,
BetaDocumentBlock,
BetaEncryptedCodeExecutionResultBlock,
BetaEncryptedCodeExecutionResultBlockParam,
BetaFallbackBlock,
BetaFallbackBlockParam,
BetaFallbackInfo,
BetaFallbackInfoParam,
BetaFallbackMessageIterationUsage,
BetaFallbackParam,
BetaFallbackRefusalTrigger,
BetaFileDocumentSource,
BetaFileImageSource,
BetaImageBlockParam,
BetaInputJSONDelta,
BetaInputTokensClearAtLeast,
BetaInputTokensTrigger,
BetaIterationsUsage,
BetaJSONOutputFormat,
BetaMCPToolConfig,
BetaMCPToolDefaultConfig,
BetaMCPToolResultBlock,
BetaMCPToolUseBlock,
BetaMCPToolUseBlockParam,
BetaMCPToolset,
BetaMemoryTool20250818,
BetaMemoryTool20250818Command,
BetaMemoryTool20250818CreateCommand,
BetaMemoryTool20250818DeleteCommand,
BetaMemoryTool20250818InsertCommand,
BetaMemoryTool20250818RenameCommand,
BetaMemoryTool20250818StrReplaceCommand,
BetaMemoryTool20250818ViewCommand,
BetaMessage,
BetaMessageDeltaUsage,
BetaMessageIterationUsage,
BetaMessageParam,
BetaMessageTokensCount,
BetaMetadata,
BetaMidConversationSystemBlockParam,
BetaOutputConfig,
BetaOutputTokensDetails,
BetaPlainTextSource,
BetaRawContentBlockDelta,
BetaRawContentBlockDeltaEvent,
BetaRawContentBlockStartEvent,
BetaRawContentBlockStopEvent,
BetaRawMessageDeltaEvent,
BetaRawMessageStartEvent,
BetaRawMessageStopEvent,
BetaRawMessageStreamEvent,
BetaRedactedThinkingBlock,
BetaRedactedThinkingBlockParam,
BetaRefusalStopDetails,
BetaRequestDocumentBlock,
BetaRequestMCPServerToolConfiguration,
BetaRequestMCPServerURLDefinition,
BetaRequestMCPToolResultBlockParam,
BetaSearchResultBlockParam,
BetaServerToolCaller,
BetaServerToolCaller20260120,
BetaServerToolUsage,
BetaServerToolUseBlock,
BetaServerToolUseBlockParam,
BetaSignatureDelta,
BetaSkill,
BetaSkillParams,
BetaStopReason,
BetaTextBlock,
BetaTextBlockParam,
BetaTextCitation,
BetaTextCitationParam,
BetaTextDelta,
BetaTextEditorCodeExecutionCreateResultBlock,
BetaTextEditorCodeExecutionCreateResultBlockParam,
BetaTextEditorCodeExecutionStrReplaceResultBlock,
BetaTextEditorCodeExecutionStrReplaceResultBlockParam,
BetaTextEditorCodeExecutionToolResultBlock,
BetaTextEditorCodeExecutionToolResultBlockParam,
BetaTextEditorCodeExecutionToolResultError,
BetaTextEditorCodeExecutionToolResultErrorParam,
BetaTextEditorCodeExecutionViewResultBlock,
BetaTextEditorCodeExecutionViewResultBlockParam,
BetaThinkingBlock,
BetaThinkingBlockParam,
BetaThinkingConfigAdaptive,
BetaThinkingConfigDisabled,
BetaThinkingConfigEnabled,
BetaThinkingConfigParam,
BetaThinkingDelta,
BetaThinkingTurns,
BetaTokenTaskBudget,
BetaTool,
BetaToolBash20241022,
BetaToolBash20250124,
BetaToolChoice,
BetaToolChoiceAny,
BetaToolChoiceAuto,
BetaToolChoiceNone,
BetaToolChoiceTool,
BetaToolComputerUse20241022,
BetaToolComputerUse20250124,
BetaToolComputerUse20251124,
BetaToolReferenceBlock,
BetaToolReferenceBlockParam,
BetaToolResultBlockParam,
BetaToolSearchToolBm25_20251119,
BetaToolSearchToolRegex20251119,
BetaToolSearchToolResultBlock,
BetaToolSearchToolResultBlockParam,
BetaToolSearchToolResultError,
BetaToolSearchToolResultErrorParam,
BetaToolSearchToolSearchResultBlock,
BetaToolSearchToolSearchResultBlockParam,
BetaToolTextEditor20241022,
BetaToolTextEditor20250124,
BetaToolTextEditor20250429,
BetaToolTextEditor20250728,
BetaToolUnion,
BetaToolUseBlock,
BetaToolUseBlockParam,
BetaToolUsesKeep,
BetaToolUsesTrigger,
BetaURLImageSource,
BetaURLPDFSource,
BetaUsage,
BetaUserLocation,
BetaWebFetchBlock,
BetaWebFetchBlockParam,
BetaWebFetchTool20250910,
BetaWebFetchTool20260209,
BetaWebFetchTool20260309,
BetaWebFetchTool20260318,
BetaWebFetchToolResultBlock,
BetaWebFetchToolResultBlockParam,
BetaWebFetchToolResultErrorBlock,
BetaWebFetchToolResultErrorBlockParam,
BetaWebFetchToolResultErrorCode,
BetaWebSearchResultBlock,
BetaWebSearchResultBlockParam,
BetaWebSearchTool20250305,
BetaWebSearchTool20260209,
BetaWebSearchTool20260318,
BetaWebSearchToolRequestError,
BetaWebSearchToolResultBlock,
BetaWebSearchToolResultBlockContent,
BetaWebSearchToolResultBlockParam,
BetaWebSearchToolResultBlockParamContent,
BetaWebSearchToolResultError,
BetaWebSearchToolResultErrorCode,
BetaBase64PDFBlock,
)

Methods:

client.beta.messages.create(**params) -> BetaMessage
client.beta.messages.count_tokens(**params) -> BetaMessageTokensCount

Batches

Types:

fromanthropic.types.beta.messagesimport (
BetaDeletedMessageBatch,
BetaMessageBatch,
BetaMessageBatchCanceledResult,
BetaMessageBatchErroredResult,
BetaMessageBatchExpiredResult,
BetaMessageBatchIndividualResponse,
BetaMessageBatchRequestCounts,
BetaMessageBatchResult,
BetaMessageBatchSucceededResult,
)

Methods:

client.beta.messages.batches.create(**params) -> BetaMessageBatch
client.beta.messages.batches.retrieve(message_batch_id) -> BetaMessageBatch
client.beta.messages.batches.list(**params) -> SyncPage[BetaMessageBatch]
client.beta.messages.batches.delete(message_batch_id) -> BetaDeletedMessageBatch
client.beta.messages.batches.cancel(message_batch_id) -> BetaMessageBatch
client.beta.messages.batches.results(message_batch_id) -> JSONLDecoder[BetaMessageBatchIndividualResponse]

Agents

Types:

fromanthropic.types.betaimport (
BetaManagedAgentsAgent,
BetaManagedAgentsAgentReference,
BetaManagedAgentsAgentToolConfig,
BetaManagedAgentsAgentToolConfigParams,
BetaManagedAgentsAgentToolsetDefaultConfig,
BetaManagedAgentsAgentToolsetDefaultConfigParams,
BetaManagedAgentsAgentToolset20260401,
BetaManagedAgentsAgentToolset20260401BashInput,
BetaManagedAgentsAgentToolset20260401EditInput,
BetaManagedAgentsAgentToolset20260401GlobInput,
BetaManagedAgentsAgentToolset20260401GrepInput,
BetaManagedAgentsAgentToolset20260401Params,
BetaManagedAgentsAgentToolset20260401ReadInput,
BetaManagedAgentsAgentToolset20260401WriteInput,
BetaManagedAgentsAlwaysAllowPolicy,
BetaManagedAgentsAlwaysAskPolicy,
BetaManagedAgentsAnthropicSkill,
BetaManagedAgentsAnthropicSkillParams,
BetaManagedAgentsCustomSkill,
BetaManagedAgentsCustomSkillParams,
BetaManagedAgentsCustomTool,
BetaManagedAgentsCustomToolInputSchema,
BetaManagedAgentsCustomToolParams,
BetaManagedAgentsMCPServerURLDefinition,
BetaManagedAgentsMCPToolConfig,
BetaManagedAgentsMCPToolConfigParams,
BetaManagedAgentsMCPToolset,
BetaManagedAgentsMCPToolsetDefaultConfig,
BetaManagedAgentsMCPToolsetDefaultConfigParams,
BetaManagedAgentsMCPToolsetParams,
BetaManagedAgentsModel,
BetaManagedAgentsModelConfig,
BetaManagedAgentsModelConfigParams,
BetaManagedAgentsMultiagentCoordinator,
BetaManagedAgentsMultiagentCoordinatorParams,
BetaManagedAgentsMultiagentSelfParams,
BetaManagedAgentsSessionThreadAgent,
BetaManagedAgentsSkillParams,
BetaManagedAgentsURLMCPServerParams,
)

Methods:

client.beta.agents.create(**params) -> BetaManagedAgentsAgent
client.beta.agents.retrieve(agent_id, **params) -> BetaManagedAgentsAgent
client.beta.agents.update(agent_id, **params) -> BetaManagedAgentsAgent
client.beta.agents.list(**params) -> SyncPageCursor[BetaManagedAgentsAgent]
client.beta.agents.archive(agent_id) -> BetaManagedAgentsAgent

Versions

Methods:

client.beta.agents.versions.list(agent_id, **params) -> SyncPageCursor[BetaManagedAgentsAgent]

Environments

Types:

fromanthropic.types.betaimport (
BetaCloudConfig,
BetaCloudConfigParams,
BetaEnvironment,
BetaEnvironmentDeleteResponse,
BetaLimitedNetwork,
BetaLimitedNetworkParams,
BetaPackages,
BetaPackagesParams,
BetaSelfHostedConfig,
BetaSelfHostedConfigParams,
BetaUnrestrictedNetwork,
)

Methods:

client.beta.environments.create(**params) -> BetaEnvironment
client.beta.environments.retrieve(environment_id) -> BetaEnvironment
client.beta.environments.update(environment_id, **params) -> BetaEnvironment
client.beta.environments.list(**params) -> SyncPageCursor[BetaEnvironment]
client.beta.environments.delete(environment_id) -> BetaEnvironmentDeleteResponse
client.beta.environments.archive(environment_id) -> BetaEnvironment

Work

Types:

fromanthropic.types.beta.environmentsimport (
BetaSelfHostedWork,
BetaSelfHostedWorkHeartbeatResponse,
BetaSelfHostedWorkListResponse,
BetaSelfHostedWorkQueueStats,
BetaSelfHostedWorkStopRequest,
BetaSelfHostedWorkUpdateRequest,
BetaSessionWorkData,
)

Methods:

client.beta.environments.work.retrieve(work_id, *, environment_id) -> BetaSelfHostedWork
client.beta.environments.work.update(work_id, *, environment_id, **params) -> BetaSelfHostedWork
client.beta.environments.work.list(environment_id, **params) -> SyncPageCursor[BetaSelfHostedWork]
client.beta.environments.work.ack(work_id, *, environment_id) -> BetaSelfHostedWork
client.beta.environments.work.heartbeat(work_id, *, environment_id, **params) -> BetaSelfHostedWorkHeartbeatResponse
client.beta.environments.work.poll(environment_id, **params) -> Optional[BetaSelfHostedWork]
client.beta.environments.work.stats(environment_id) -> BetaSelfHostedWorkQueueStats
client.beta.environments.work.stop(work_id, *, environment_id, **params) -> BetaSelfHostedWork

Sessions

Types:

fromanthropic.types.betaimport (
BetaManagedAgentsAgentMessagePreview,
BetaManagedAgentsAgentParams,
BetaManagedAgentsAgentThinkingPreview,
BetaManagedAgentsAgentWithOverridesParams,
BetaManagedAgentsBranchCheckout,
BetaManagedAgentsCacheCreationUsage,
BetaManagedAgentsCommitCheckout,
BetaManagedAgentsDeletedSession,
BetaManagedAgentsDeltaContent,
BetaManagedAgentsDeltaEvent,
BetaManagedAgentsDeltaType,
BetaManagedAgentsFileResourceParams,
BetaManagedAgentsGitHubRepositoryResourceParams,
BetaManagedAgentsMemoryStoreResourceParam,
BetaManagedAgentsMultiagent,
BetaManagedAgentsMultiagentParams,
BetaManagedAgentsMultiagentRosterEntryParams,
BetaManagedAgentsOutcomeEvaluationResource,
BetaManagedAgentsSession,
BetaManagedAgentsSessionAgent,
BetaManagedAgentsSessionAgentUpdate,
BetaManagedAgentsSessionMultiagentCoordinator,
BetaManagedAgentsSessionStats,
BetaManagedAgentsSessionUpdatedEvent,
BetaManagedAgentsSessionUsage,
BetaManagedAgentsStartEvent,
BetaManagedAgentsStartEventPreview,
BetaManagedAgentsSystemContentBlock,
BetaManagedAgentsSystemMessageEvent,
BetaManagedAgentsUserToolResultEvent,
)

Methods:

client.beta.sessions.create(**params) -> BetaManagedAgentsSession
client.beta.sessions.retrieve(session_id) -> BetaManagedAgentsSession
client.beta.sessions.update(session_id, **params) -> BetaManagedAgentsSession
client.beta.sessions.list(**params) -> SyncBidirectionalPageCursor[BetaManagedAgentsSession]
client.beta.sessions.delete(session_id) -> BetaManagedAgentsDeletedSession
client.beta.sessions.archive(session_id) -> BetaManagedAgentsSession

Events

Types:

fromanthropic.types.beta.sessionsimport (
BetaManagedAgentsAgentCustomToolUseEvent,
BetaManagedAgentsAgentMCPToolResultEvent,
BetaManagedAgentsAgentMCPToolUseEvent,
BetaManagedAgentsAgentMessageEvent,
BetaManagedAgentsAgentThinkingEvent,
BetaManagedAgentsAgentThreadContextCompactedEvent,
BetaManagedAgentsAgentThreadMessageReceivedEvent,
BetaManagedAgentsAgentThreadMessageSentEvent,
BetaManagedAgentsAgentToolResultEvent,
BetaManagedAgentsAgentToolUseEvent,
BetaManagedAgentsBase64DocumentSource,
BetaManagedAgentsBase64ImageSource,
BetaManagedAgentsBillingError,
BetaManagedAgentsCredentialHostUnreachableError,
BetaManagedAgentsDocumentBlock,
BetaManagedAgentsEventParams,
BetaManagedAgentsFileDocumentSource,
BetaManagedAgentsFileImageSource,
BetaManagedAgentsFileRubric,
BetaManagedAgentsFileRubricParams,
BetaManagedAgentsImageBlock,
BetaManagedAgentsMCPAuthenticationFailedError,
BetaManagedAgentsMCPConnectionFailedError,
BetaManagedAgentsModelOverloadedError,
BetaManagedAgentsModelRateLimitedError,
BetaManagedAgentsModelRequestFailedError,
BetaManagedAgentsPlainTextDocumentSource,
BetaManagedAgentsRetryStatusExhausted,
BetaManagedAgentsRetryStatusRetrying,
BetaManagedAgentsRetryStatusTerminal,
BetaManagedAgentsSearchResultBlock,
BetaManagedAgentsSearchResultCitations,
BetaManagedAgentsSearchResultContent,
BetaManagedAgentsSendSessionEvents,
BetaManagedAgentsSessionDeletedEvent,
BetaManagedAgentsSessionEndTurn,
BetaManagedAgentsSessionErrorEvent,
BetaManagedAgentsSessionEvent,
BetaManagedAgentsSessionRequiresAction,
BetaManagedAgentsSessionRetriesExhausted,
BetaManagedAgentsSessionStatusIdleEvent,
BetaManagedAgentsSessionStatusRescheduledEvent,
BetaManagedAgentsSessionStatusRunningEvent,
BetaManagedAgentsSessionStatusTerminatedEvent,
BetaManagedAgentsSessionThreadCreatedEvent,
BetaManagedAgentsSessionThreadStatusIdleEvent,
BetaManagedAgentsSessionThreadStatusRescheduledEvent,
BetaManagedAgentsSessionThreadStatusRunningEvent,
BetaManagedAgentsSessionThreadStatusTerminatedEvent,
BetaManagedAgentsSpanModelRequestEndEvent,
BetaManagedAgentsSpanModelRequestStartEvent,
BetaManagedAgentsSpanModelUsage,
BetaManagedAgentsSpanOutcomeEvaluationEndEvent,
BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent,
BetaManagedAgentsSpanOutcomeEvaluationStartEvent,
BetaManagedAgentsStreamSessionEvents,
BetaManagedAgentsSystemMessageEventParams,
BetaManagedAgentsTextBlock,
BetaManagedAgentsTextRubric,
BetaManagedAgentsTextRubricParams,
BetaManagedAgentsUnknownError,
BetaManagedAgentsURLDocumentSource,
BetaManagedAgentsURLImageSource,
BetaManagedAgentsUserCustomToolResultEvent,
BetaManagedAgentsUserCustomToolResultEventParams,
BetaManagedAgentsUserDefineOutcomeEvent,
BetaManagedAgentsUserDefineOutcomeEventParams,
BetaManagedAgentsUserInterruptEvent,
BetaManagedAgentsUserInterruptEventParams,
BetaManagedAgentsUserMessageEvent,
BetaManagedAgentsUserMessageEventParams,
BetaManagedAgentsUserToolConfirmationEvent,
BetaManagedAgentsUserToolConfirmationEventParams,
BetaManagedAgentsUserToolResultEventParams,
)

Methods:

client.beta.sessions.events.list(session_id, **params) -> SyncPageCursor[BetaManagedAgentsSessionEvent]
client.beta.sessions.events.send(session_id, **params) -> BetaManagedAgentsSendSessionEvents
client.beta.sessions.events.stream(session_id, **params) -> BetaManagedAgentsStreamSessionEvents

Resources

Types:

fromanthropic.types.beta.sessionsimport (
BetaManagedAgentsDeleteSessionResource,
BetaManagedAgentsFileResource,
BetaManagedAgentsGitHubRepositoryResource,
BetaManagedAgentsMemoryStoreResource,
BetaManagedAgentsSessionResource,
ResourceRetrieveResponse,
ResourceUpdateResponse,
)

Methods:

client.beta.sessions.resources.retrieve(resource_id, *, session_id) -> ResourceRetrieveResponse
client.beta.sessions.resources.update(resource_id, *, session_id, **params) -> ResourceUpdateResponse
client.beta.sessions.resources.list(session_id, **params) -> SyncPageCursor[BetaManagedAgentsSessionResource]
client.beta.sessions.resources.delete(resource_id, *, session_id) -> BetaManagedAgentsDeleteSessionResource
client.beta.sessions.resources.add(session_id, **params) -> BetaManagedAgentsFileResource

Threads

Types:

fromanthropic.types.beta.sessionsimport (
BetaManagedAgentsSessionThread,
BetaManagedAgentsSessionThreadStats,
BetaManagedAgentsSessionThreadStatus,
BetaManagedAgentsSessionThreadUsage,
BetaManagedAgentsStreamSessionThreadEvents,
)

Methods:

client.beta.sessions.threads.retrieve(thread_id, *, session_id) -> BetaManagedAgentsSessionThread
client.beta.sessions.threads.list(session_id, **params) -> SyncPageCursor[BetaManagedAgentsSessionThread]
client.beta.sessions.threads.archive(thread_id, *, session_id) -> BetaManagedAgentsSessionThread

Events

Methods:

client.beta.sessions.threads.events.list(thread_id, *, session_id, **params) -> SyncPageCursor[BetaManagedAgentsSessionEvent]
client.beta.sessions.threads.events.stream(thread_id, *, session_id) -> BetaManagedAgentsStreamSessionThreadEvents

Deployments

Types:

fromanthropic.types.betaimport (
BetaManagedAgentsAgentArchivedDeploymentPausedReasonError,
BetaManagedAgentsCronSchedule,
BetaManagedAgentsCronScheduleParams,
BetaManagedAgentsDeployment,
BetaManagedAgentsDeploymentInitialEvent,
BetaManagedAgentsDeploymentInitialEventParams,
BetaManagedAgentsDeploymentPausedReason,
BetaManagedAgentsDeploymentPausedReasonError,
BetaManagedAgentsDeploymentStatus,
BetaManagedAgentsDeploymentSystemMessageEvent,
BetaManagedAgentsDeploymentUserDefineOutcomeEvent,
BetaManagedAgentsDeploymentUserMessageEvent,
BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError,
BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError,
BetaManagedAgentsErrorDeploymentPausedReason,
BetaManagedAgentsFileNotFoundDeploymentPausedReasonError,
BetaManagedAgentsFileResourceConfig,
BetaManagedAgentsGitHubRepositoryResourceConfig,
BetaManagedAgentsManualDeploymentPausedReason,
BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError,
BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError,
BetaManagedAgentsMemoryStoreResourceConfig,
BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError,
BetaManagedAgentsSchedule,
BetaManagedAgentsScheduleParams,
BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError,
BetaManagedAgentsSessionResourceConfig,
BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError,
BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError,
BetaManagedAgentsUnknownDeploymentPausedReasonError,
BetaManagedAgentsVaultArchivedDeploymentPausedReasonError,
BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError,
BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError,
)

Methods:

client.beta.deployments.create(**params) -> BetaManagedAgentsDeployment
client.beta.deployments.retrieve(deployment_id) -> BetaManagedAgentsDeployment
client.beta.deployments.update(deployment_id, **params) -> BetaManagedAgentsDeployment
client.beta.deployments.list(**params) -> SyncPageCursor[BetaManagedAgentsDeployment]
client.beta.deployments.archive(deployment_id) -> BetaManagedAgentsDeployment
client.beta.deployments.pause(deployment_id) -> BetaManagedAgentsDeployment
client.beta.deployments.run(deployment_id) -> BetaManagedAgentsDeploymentRun
client.beta.deployments.unpause(deployment_id) -> BetaManagedAgentsDeployment

DeploymentRuns

Types:

fromanthropic.types.betaimport (
BetaManagedAgentsAgentArchivedRunError,
BetaManagedAgentsDeploymentRun,
BetaManagedAgentsEnvironmentArchivedRunError,
BetaManagedAgentsEnvironmentNotFoundRunError,
BetaManagedAgentsFileNotFoundRunError,
BetaManagedAgentsManualTriggerContext,
BetaManagedAgentsMCPEgressBlockedRunError,
BetaManagedAgentsMemoryStoreArchivedRunError,
BetaManagedAgentsOrganizationDisabledRunError,
BetaManagedAgentsScheduleTriggerContext,
BetaManagedAgentsSelfHostedResourcesUnsupportedRunError,
BetaManagedAgentsSessionCreationRejectedRunError,
BetaManagedAgentsSessionRateLimitedRunError,
BetaManagedAgentsSessionResourceNotFoundRunError,
BetaManagedAgentsSkillNotFoundRunError,
BetaManagedAgentsTriggerContext,
BetaManagedAgentsTriggerType,
BetaManagedAgentsUnknownRunError,
BetaManagedAgentsVaultArchivedRunError,
BetaManagedAgentsVaultNotFoundRunError,
BetaManagedAgentsWorkspaceArchivedRunError,
)

Methods:

client.beta.deployment_runs.retrieve(deployment_run_id) -> BetaManagedAgentsDeploymentRun
client.beta.deployment_runs.list(**params) -> SyncPageCursor[BetaManagedAgentsDeploymentRun]

Vaults

Types:

fromanthropic.types.betaimportBetaManagedAgentsDeletedVault, BetaManagedAgentsVault

Methods:

client.beta.vaults.create(**params) -> BetaManagedAgentsVault
client.beta.vaults.retrieve(vault_id) -> BetaManagedAgentsVault
client.beta.vaults.update(vault_id, **params) -> BetaManagedAgentsVault
client.beta.vaults.list(**params) -> SyncPageCursor[BetaManagedAgentsVault]
client.beta.vaults.delete(vault_id) -> BetaManagedAgentsDeletedVault
client.beta.vaults.archive(vault_id) -> BetaManagedAgentsVault

Credentials

Types:

fromanthropic.types.beta.vaultsimport (
BetaManagedAgentsCredential,
BetaManagedAgentsCredentialNetworkingParams,
BetaManagedAgentsCredentialValidation,
BetaManagedAgentsCredentialValidationStatus,
BetaManagedAgentsDeletedCredential,
BetaManagedAgentsEnvironmentVariableAuthResponse,
BetaManagedAgentsEnvironmentVariableCreateParams,
BetaManagedAgentsEnvironmentVariableUpdateParams,
BetaManagedAgentsInjectionLocationParams,
BetaManagedAgentsInjectionLocationResponse,
BetaManagedAgentsInjectionLocationUpdateParams,
BetaManagedAgentsLimitedCredentialNetworkingParams,
BetaManagedAgentsLimitedCredentialNetworkingResponse,
BetaManagedAgentsMCPOAuthAuthResponse,
BetaManagedAgentsMCPOAuthCreateParams,
BetaManagedAgentsMCPOAuthRefreshParams,
BetaManagedAgentsMCPOAuthRefreshResponse,
BetaManagedAgentsMCPOAuthRefreshUpdateParams,
BetaManagedAgentsMCPOAuthUpdateParams,
BetaManagedAgentsMCPProbe,
BetaManagedAgentsRefreshHTTPResponse,
BetaManagedAgentsRefreshObject,
BetaManagedAgentsStaticBearerAuthResponse,
BetaManagedAgentsStaticBearerCreateParams,
BetaManagedAgentsStaticBearerUpdateParams,
BetaManagedAgentsTokenEndpointAuthBasicParam,
BetaManagedAgentsTokenEndpointAuthBasicResponse,
BetaManagedAgentsTokenEndpointAuthBasicUpdateParam,
BetaManagedAgentsTokenEndpointAuthNoneParam,
BetaManagedAgentsTokenEndpointAuthNoneResponse,
BetaManagedAgentsTokenEndpointAuthPostParam,
BetaManagedAgentsTokenEndpointAuthPostResponse,
BetaManagedAgentsTokenEndpointAuthPostUpdateParam,
BetaManagedAgentsUnrestrictedCredentialNetworkingParams,
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse,
)

Methods:

client.beta.vaults.credentials.create(vault_id, **params) -> BetaManagedAgentsCredential
client.beta.vaults.credentials.retrieve(credential_id, *, vault_id) -> BetaManagedAgentsCredential
client.beta.vaults.credentials.update(credential_id, *, vault_id, **params) -> BetaManagedAgentsCredential
client.beta.vaults.credentials.list(vault_id, **params) -> SyncPageCursor[BetaManagedAgentsCredential]
client.beta.vaults.credentials.delete(credential_id, *, vault_id) -> BetaManagedAgentsDeletedCredential
client.beta.vaults.credentials.archive(credential_id, *, vault_id) -> BetaManagedAgentsCredential
client.beta.vaults.credentials.mcp_oauth_validate(credential_id, *, vault_id) -> BetaManagedAgentsCredentialValidation

MemoryStores

Types:

fromanthropic.types.betaimportBetaManagedAgentsDeletedMemoryStore, BetaManagedAgentsMemoryStore

Methods:

client.beta.memory_stores.create(**params) -> BetaManagedAgentsMemoryStore
client.beta.memory_stores.retrieve(memory_store_id) -> BetaManagedAgentsMemoryStore
client.beta.memory_stores.update(memory_store_id, **params) -> BetaManagedAgentsMemoryStore
client.beta.memory_stores.list(**params) -> SyncPageCursor[BetaManagedAgentsMemoryStore]
client.beta.memory_stores.delete(memory_store_id) -> BetaManagedAgentsDeletedMemoryStore
client.beta.memory_stores.archive(memory_store_id) -> BetaManagedAgentsMemoryStore

Memories

Types:

fromanthropic.types.beta.memory_storesimport (
BetaManagedAgentsConflictError,
BetaManagedAgentsContentSha256Precondition,
BetaManagedAgentsDeletedMemory,
BetaManagedAgentsError,
BetaManagedAgentsMemory,
BetaManagedAgentsMemoryListItem,
BetaManagedAgentsMemoryPathConflictError,
BetaManagedAgentsMemoryPreconditionFailedError,
BetaManagedAgentsMemoryPrefix,
BetaManagedAgentsMemoryView,
BetaManagedAgentsPrecondition,
)

Methods:

client.beta.memory_stores.memories.create(memory_store_id, **params) -> BetaManagedAgentsMemory
client.beta.memory_stores.memories.retrieve(memory_id, *, memory_store_id, **params) -> BetaManagedAgentsMemory
client.beta.memory_stores.memories.update(memory_id, *, memory_store_id, **params) -> BetaManagedAgentsMemory
client.beta.memory_stores.memories.list(memory_store_id, **params) -> SyncPageCursor[BetaManagedAgentsMemoryListItem]
client.beta.memory_stores.memories.delete(memory_id, *, memory_store_id, **params) -> BetaManagedAgentsDeletedMemory

MemoryVersions

Types:

fromanthropic.types.beta.memory_storesimport (
BetaManagedAgentsActor,
BetaManagedAgentsAPIActor,
BetaManagedAgentsMemoryVersion,
BetaManagedAgentsMemoryVersionOperation,
BetaManagedAgentsSessionActor,
BetaManagedAgentsUserActor,
)

Methods:

client.beta.memory_stores.memory_versions.retrieve(memory_version_id, *, memory_store_id, **params) -> BetaManagedAgentsMemoryVersion
client.beta.memory_stores.memory_versions.list(memory_store_id, **params) -> SyncPageCursor[BetaManagedAgentsMemoryVersion]
client.beta.memory_stores.memory_versions.redact(memory_version_id, *, memory_store_id) -> BetaManagedAgentsMemoryVersion

Files

Types:

fromanthropic.types.betaimportBetaFileScope, DeletedFile, FileMetadata

Methods:

client.beta.files.list(**params) -> SyncPage[FileMetadata]
client.beta.files.delete(file_id) -> DeletedFile
client.beta.files.download(file_id) -> BinaryAPIResponse
client.beta.files.retrieve_metadata(file_id) -> FileMetadata
client.beta.files.upload(**params) -> FileMetadata

Skills

Types:

fromanthropic.types.betaimport (
SkillCreateResponse,
SkillRetrieveResponse,
SkillListResponse,
SkillDeleteResponse,
)

Methods:

client.beta.skills.create(**params) -> SkillCreateResponse
client.beta.skills.retrieve(skill_id) -> SkillRetrieveResponse
client.beta.skills.list(**params) -> SyncPageCursor[SkillListResponse]
client.beta.skills.delete(skill_id) -> SkillDeleteResponse

Versions

Types:

fromanthropic.types.beta.skillsimport (
VersionCreateResponse,
VersionRetrieveResponse,
VersionListResponse,
VersionDeleteResponse,
)

Methods:

client.beta.skills.versions.create(skill_id, **params) -> VersionCreateResponse
client.beta.skills.versions.retrieve(version, *, skill_id) -> VersionRetrieveResponse
client.beta.skills.versions.list(skill_id, **params) -> SyncPageCursor[VersionListResponse]
client.beta.skills.versions.delete(version, *, skill_id) -> VersionDeleteResponse
client.beta.skills.versions.download(version, *, skill_id) -> BinaryAPIResponse

Webhooks

Types:

fromanthropic.types.betaimport (
BetaWebhookAgentArchivedEventData,
BetaWebhookAgentCreatedEventData,
BetaWebhookAgentDeletedEventData,
BetaWebhookAgentUpdatedEventData,
BetaWebhookDeploymentArchivedEventData,
BetaWebhookDeploymentCreatedEventData,
BetaWebhookDeploymentDeletedEventData,
BetaWebhookDeploymentPausedEventData,
BetaWebhookDeploymentRunFailedEventData,
BetaWebhookDeploymentRunStartedEventData,
BetaWebhookDeploymentRunSucceededEventData,
BetaWebhookDeploymentUnpausedEventData,
BetaWebhookDeploymentUpdatedEventData,
BetaWebhookEvent,
BetaWebhookEventData,
BetaWebhookSessionArchivedEventData,
BetaWebhookSessionCreatedEventData,
BetaWebhookSessionDeletedEventData,
BetaWebhookSessionIdledEventData,
BetaWebhookSessionOutcomeEvaluationEndedEventData,
BetaWebhookSessionPendingEventData,
BetaWebhookSessionRequiresActionEventData,
BetaWebhookSessionRunningEventData,
BetaWebhookSessionStatusIdledEventData,
BetaWebhookSessionStatusRescheduledEventData,
BetaWebhookSessionStatusRunStartedEventData,
BetaWebhookSessionStatusTerminatedEventData,
BetaWebhookSessionThreadCreatedEventData,
BetaWebhookSessionThreadIdledEventData,
BetaWebhookSessionThreadTerminatedEventData,
BetaWebhookSessionUpdatedEventData,
BetaWebhookVaultArchivedEventData,
BetaWebhookVaultCreatedEventData,
BetaWebhookVaultCredentialArchivedEventData,
BetaWebhookVaultCredentialCreatedEventData,
BetaWebhookVaultCredentialDeletedEventData,
BetaWebhookVaultCredentialRefreshFailedEventData,
BetaWebhookVaultDeletedEventData,
UnwrapWebhookEvent,
)

UserProfiles

Types:

fromanthropic.types.betaimport (
BetaUserProfile,
BetaUserProfileEnrollmentURL,
BetaUserProfileTrustGrant,
)

Methods:

client.beta.user_profiles.create(**params) -> BetaUserProfile
client.beta.user_profiles.retrieve(user_profile_id) -> BetaUserProfile
client.beta.user_profiles.update(user_profile_id, **params) -> BetaUserProfile
client.beta.user_profiles.list(**params) -> SyncPageCursor[BetaUserProfile]
client.beta.user_profiles.create_enrollment_url(user_profile_id) -> BetaUserProfileEnrollmentURL

Dreams

Types:

fromanthropic.types.betaimport (
BetaDream,
BetaDreamError,
BetaDreamInput,
BetaDreamMemoryStoreInput,
BetaDreamMemoryStoreOutput,
BetaDreamModelConfig,
BetaDreamModelConfigParam,
BetaDreamOutput,
BetaDreamSessionsInput,
BetaDreamStatus,
BetaDreamUsage,
)

Methods:

client.beta.dreams.create(**params) -> BetaDream
client.beta.dreams.retrieve(dream_id) -> BetaDream
client.beta.dreams.list(**params) -> SyncPageCursor[BetaDream]
client.beta.dreams.archive(dream_id) -> BetaDream
client.beta.dreams.cancel(dream_id) -> BetaDream

Tunnels

Types:

fromanthropic.types.betaimportBetaTunnel, BetaTunnelToken

Methods:

client.beta.tunnels.create(**params) -> BetaTunnel
client.beta.tunnels.retrieve(tunnel_id) -> BetaTunnel
client.beta.tunnels.list(**params) -> SyncPageCursor[BetaTunnel]
client.beta.tunnels.archive(tunnel_id) -> BetaTunnel
client.beta.tunnels.reveal_token(tunnel_id) -> BetaTunnelToken
client.beta.tunnels.rotate_token(tunnel_id, **params) -> BetaTunnelToken

Certificates

Types:

fromanthropic.types.beta.tunnelsimportBetaTunnelCertificate

Methods:

client.beta.tunnels.certificates.create(tunnel_id, **params) -> BetaTunnelCertificate
client.beta.tunnels.certificates.retrieve(certificate_id, *, tunnel_id) -> BetaTunnelCertificate
client.beta.tunnels.certificates.list(tunnel_id, **params) -> SyncPageCursor[BetaTunnelCertificate]
client.beta.tunnels.certificates.archive(certificate_id, *, tunnel_id) -> BetaTunnelCertificate

FilesExpand file tree

api.md

Latest commit

History

api.md

File metadata and controls

Shared Types

Messages

Batches

Models

Beta

Models

Messages

Batches

Agents

Versions

Environments

Work

Sessions

Events

Resources

Threads

Events

Deployments

DeploymentRuns

Vaults

Credentials

MemoryStores

Memories

MemoryVersions

Files

Skills

Versions

Webhooks

UserProfiles

Dreams

Tunnels

Certificates