Anthropic
Shared
Types:
APIErrorObjectAuthenticationErrorBillingErrorErrorObjectErrorResponseErrorTypeGatewayTimeoutErrorInvalidRequestErrorNotFoundErrorOverloadedErrorPermissionErrorRateLimitError
Messages
Types:
Base64ImageSourceBase64PDFSourceBashCodeExecutionOutputBlockBashCodeExecutionOutputBlockParamBashCodeExecutionResultBlockBashCodeExecutionResultBlockParamBashCodeExecutionToolResultBlockBashCodeExecutionToolResultBlockParamBashCodeExecutionToolResultErrorBashCodeExecutionToolResultErrorCodeBashCodeExecutionToolResultErrorParamBrowserCloseTabConfigBrowserDoubleClickConfigBrowserFileUploadConfigBrowserFindConfigBrowserFormInputConfigBrowserGetPageTextConfigBrowserHoldKeyConfigBrowserHoverConfigBrowserJavascriptExecConfigBrowserKeyConfigBrowserLeftClickConfigBrowserLeftClickDragConfigBrowserLeftMouseDownConfigBrowserLeftMouseUpConfigBrowserListTabsConfigBrowserMiddleClickConfigBrowserMouseMoveConfigBrowserNavigateConfigBrowserNewTabConfigBrowserReadConsoleConfigBrowserReadNetworkConfigBrowserReadPageConfigBrowserRightClickConfigBrowserScreenshotConfigBrowserScrollConfigBrowserScrollToConfigBrowserStateBlockParamBrowserStateChangeBrowserStateChangeDownloadCompletedBrowserStateChangeDownloadFailedBrowserStateChangeDownloadStartedBrowserStateChangeTabOpenedBrowserStateTabEntryBrowserSwitchTabConfigBrowserToolset20260801BrowserToolsetConfigsBrowserTripleClickConfigBrowserTypeConfigBrowserWaitConfigBrowserZoomConfigCacheControlEphemeralCacheCreationCitationCharLocationCitationCharLocationParamCitationContentBlockLocationCitationContentBlockLocationParamCitationPageLocationCitationPageLocationParamCitationSearchResultLocationParamCitationWebSearchResultLocationParamCitationsConfigCitationsConfigParamCitationsDeltaCitationsSearchResultLocationCitationsWebSearchResultLocationCodeExecutionOutputBlockCodeExecutionOutputBlockParamCodeExecutionResultBlockCodeExecutionResultBlockParamCodeExecutionTool20250522CodeExecutionTool20250825CodeExecutionTool20260120CodeExecutionTool20260521CodeExecutionToolResultBlockCodeExecutionToolResultBlockContentCodeExecutionToolResultBlockParamCodeExecutionToolResultBlockParamContentCodeExecutionToolResultErrorCodeExecutionToolResultErrorCodeCodeExecutionToolResultErrorParamComputerCursorPositionConfigComputerDoubleClickConfigComputerHoldKeyConfigComputerKeyConfigComputerLeftClickConfigComputerLeftClickDragConfigComputerLeftMouseDownConfigComputerLeftMouseUpConfigComputerMiddleClickConfigComputerMouseMoveConfigComputerRightClickConfigComputerScreenshotConfigComputerScrollConfigComputerToolset20260801ComputerToolsetConfigsComputerTripleClickConfigComputerTypeConfigComputerWaitConfigComputerZoomConfigContainerContainerParamsContainerSkillContainerUploadBlockContainerUploadBlockParamContentBlockContentBlockParamContentBlockSourceContentBlockSourceContentContentBlockStartEventContentBlockStopEventDirectCallerDocumentBlockDocumentBlockParamEncryptedCodeExecutionResultBlockEncryptedCodeExecutionResultBlockParamFileDocumentSourceFileImageSourceImageBlockParamImageTransformationsParamInputJSONDeltaJSONOutputFormatMemoryTool20250818MessageMessageCountTokensToolMessageCreateParamsContainerMessageDeltaEventMessageDeltaUsageMessageParamMessageTokensCountMetadataModelOutputConfigOutputTokensDetailsPlainTextSourceRawContentBlockDeltaRawContentBlockDeltaEventRawContentBlockStartEventRawContentBlockStopEventRawMessageDeltaEventRawMessageStartEventRawMessageStopEventRawMessageStreamEventRedactedThinkingBlockRedactedThinkingBlockParamRefusalStopDetailsSearchResultBlockParamServerToolCallerServerToolCaller20260120ServerToolUsageServerToolUseBlockServerToolUseBlockParamSignatureDeltaSkillParamsStopReasonTextBlockTextBlockParamTextCitationTextCitationParamTextDeltaTextEditorCodeExecutionCreateResultBlockTextEditorCodeExecutionCreateResultBlockParamTextEditorCodeExecutionStrReplaceResultBlockTextEditorCodeExecutionStrReplaceResultBlockParamTextEditorCodeExecutionToolResultBlockTextEditorCodeExecutionToolResultBlockParamTextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultErrorCodeTextEditorCodeExecutionToolResultErrorParamTextEditorCodeExecutionViewResultBlockTextEditorCodeExecutionViewResultBlockParamThinkingBlockThinkingBlockParamThinkingConfigAdaptiveThinkingConfigDisabledThinkingConfigEnabledThinkingConfigParamThinkingDeltaToolToolBash20250124ToolChoiceToolChoiceAnyToolChoiceAutoToolChoiceNoneToolChoiceToolToolReferenceBlockToolReferenceBlockParamToolResultBlockParamToolSearchToolBm25_20251119ToolSearchToolRegex20251119ToolSearchToolResultBlockToolSearchToolResultBlockParamToolSearchToolResultErrorToolSearchToolResultErrorCodeToolSearchToolResultErrorParamToolSearchToolSearchResultBlockToolSearchToolSearchResultBlockParamToolTextEditor20250124ToolTextEditor20250429ToolTextEditor20250728ToolUnionToolUseBlockToolUseBlockParamURLImageSourceURLPDFSourceUsageUserLocationWebFetchBlockWebFetchBlockParamWebFetchTool20250910WebFetchTool20260209WebFetchTool20260309WebFetchTool20260318WebFetchToolResultBlockWebFetchToolResultBlockParamWebFetchToolResultErrorBlockWebFetchToolResultErrorBlockParamWebFetchToolResultErrorCodeWebFetchURLSourceAllWebFetchURLSourceExceptWebFetchURLSourceNoneWebFetchURLSourceOnlyWebFetchURLSourceToolReferenceWebFetchURLSourcesWebSearchResultBlockWebSearchResultBlockParamWebSearchTool20250305WebSearchTool20260209WebSearchTool20260318WebSearchToolRequestErrorWebSearchToolResultBlockWebSearchToolResultBlockContentWebSearchToolResultBlockParamWebSearchToolResultBlockParamContentWebSearchToolResultErrorWebSearchToolResultErrorCodeMessageStreamEventMessageStartEventMessageDeltaEventMessageStopEventContentBlockStartEventContentBlockDeltaEventContentBlockStopEvent
Methods:
client.messages.create({ ...params }) -> Messageclient.messages.countTokens({ ...params }) -> MessageTokensCountclient.messages.stream(body, options?) -> MessageStream
Batches
Types:
DeletedMessageBatchMessageBatchMessageBatchCanceledResultMessageBatchErroredResultMessageBatchExpiredResultMessageBatchIndividualResponseMessageBatchRequestCountsMessageBatchResultMessageBatchSucceededResult
Methods:
client.messages.batches.create({ ...params }) -> MessageBatchclient.messages.batches.retrieve(messageBatchID, { ...params }) -> MessageBatchclient.messages.batches.list({ ...params }) -> MessageBatchesPageclient.messages.batches.delete(messageBatchID, { ...params }) -> DeletedMessageBatchclient.messages.batches.cancel(messageBatchID, { ...params }) -> MessageBatchclient.messages.batches.results(messageBatchID, { ...params }) -> MessageBatchIndividualResponse
Models
Types:
CapabilitySupportContextManagementCapabilityEffortCapabilityModelCapabilitiesModelInfoThinkingCapabilityThinkingTypes
Methods:
client.models.retrieve(modelID, { ...params }) -> ModelInfoclient.models.list({ ...params }) -> ModelInfosPage
Files
Types:
Methods:
client.files.list({ ...params }) -> FileMetadataPageCursorclient.files.delete(fileID, { ...params }) -> DeletedFileclient.files.download(fileID, { ...params }) -> Responseclient.files.retrieveMetadata(fileID, { ...params }) -> FileMetadataclient.files.upload({ ...params }) -> FileMetadata
Skills
Types:
Methods:
client.skills.create({ ...params }) -> Skillclient.skills.retrieve(skillID, { ...params }) -> Skillclient.skills.list({ ...params }) -> SkillsPageCursorclient.skills.delete(skillID, { ...params }) -> DeletedSkill
Versions
Types:
Methods:
client.skills.versions.create(skillID, { ...params }) -> SkillVersionclient.skills.versions.retrieve(version, { ...params }) -> SkillVersionclient.skills.versions.list(skillID, { ...params }) -> SkillVersionsPageCursorclient.skills.versions.delete(version, { ...params }) -> DeletedSkillVersion
Beta
Types:
AnthropicBetaBetaAPIErrorBetaAuthenticationErrorBetaBillingErrorBetaCurrencyBetaErrorBetaErrorResponseBetaGatewayTimeoutErrorBetaInvalidRequestErrorBetaMonetaryAmountBetaNotFoundErrorBetaOverloadedErrorBetaPermissionErrorBetaRateLimitError
Models
Types:
BetaCapabilitySupportBetaCompactionCapabilityBetaContextManagementCapabilityBetaEffortCapabilityBetaModelCapabilitiesBetaModelInfoBetaThinkingCapabilityBetaThinkingTypes
Methods:
client.beta.models.retrieve(modelID, { ...params }) -> BetaModelInfoclient.beta.models.list({ ...params }) -> BetaModelInfosPage
Messages
Types:
BetaAdvisorMessageIterationUsageBetaAdvisorRedactedResultBlockBetaAdvisorRedactedResultBlockParamBetaAdvisorResultBlockBetaAdvisorResultBlockParamBetaAdvisorTool20260301BetaAdvisorToolResultBlockBetaAdvisorToolResultBlockParamBetaAdvisorToolResultErrorBetaAdvisorToolResultErrorParamBetaAllThinkingTurnsBetaBase64ImageSourceBetaBase64PDFSourceBetaBashCodeExecutionOutputBlockBetaBashCodeExecutionOutputBlockParamBetaBashCodeExecutionResultBlockBetaBashCodeExecutionResultBlockParamBetaBashCodeExecutionToolResultBlockBetaBashCodeExecutionToolResultBlockParamBetaBashCodeExecutionToolResultErrorBetaBashCodeExecutionToolResultErrorParamBetaBrowserCloseTabConfigBetaBrowserDoubleClickConfigBetaBrowserFileUploadConfigBetaBrowserFindConfigBetaBrowserFormInputConfigBetaBrowserGetPageTextConfigBetaBrowserHoldKeyConfigBetaBrowserHoverConfigBetaBrowserJavascriptExecConfigBetaBrowserKeyConfigBetaBrowserLeftClickConfigBetaBrowserLeftClickDragConfigBetaBrowserLeftMouseDownConfigBetaBrowserLeftMouseUpConfigBetaBrowserListTabsConfigBetaBrowserMiddleClickConfigBetaBrowserMouseMoveConfigBetaBrowserNavigateConfigBetaBrowserNewTabConfigBetaBrowserReadConsoleConfigBetaBrowserReadNetworkConfigBetaBrowserReadPageConfigBetaBrowserRightClickConfigBetaBrowserScreenshotConfigBetaBrowserScrollConfigBetaBrowserScrollToConfigBetaBrowserStateBlockParamBetaBrowserStateChangeBetaBrowserStateChangeDownloadCompletedBetaBrowserStateChangeDownloadFailedBetaBrowserStateChangeDownloadStartedBetaBrowserStateChangeTabOpenedBetaBrowserStateTabEntryBetaBrowserSwitchTabConfigBetaBrowserToolset20260801BetaBrowserToolsetConfigsBetaBrowserTripleClickConfigBetaBrowserTypeConfigBetaBrowserWaitConfigBetaBrowserZoomConfigBetaCacheControlEphemeralBetaCacheCreationBetaCacheMissMessagesChangedBetaCacheMissModelChangedBetaCacheMissPreviousMessageNotFoundBetaCacheMissSystemChangedBetaCacheMissToolsChangedBetaCacheMissUnavailableBetaCitationCharLocationBetaCitationCharLocationParamBetaCitationConfigBetaCitationContentBlockLocationBetaCitationContentBlockLocationParamBetaCitationPageLocationBetaCitationPageLocationParamBetaCitationSearchResultLocationBetaCitationSearchResultLocationParamBetaCitationWebSearchResultLocationParamBetaCitationsConfigParamBetaCitationsDeltaBetaCitationsWebSearchResultLocationBetaClearThinking20251015EditBetaClearThinking20251015EditResponseBetaClearToolUses20250919EditBetaClearToolUses20250919EditResponseBetaCodeExecutionOutputBlockBetaCodeExecutionOutputBlockParamBetaCodeExecutionResultBlockBetaCodeExecutionResultBlockParamBetaCodeExecutionTool20250522BetaCodeExecutionTool20250825BetaCodeExecutionTool20260120BetaCodeExecutionTool20260521BetaCodeExecutionToolResultBlockBetaCodeExecutionToolResultBlockContentBetaCodeExecutionToolResultBlockParamBetaCodeExecutionToolResultBlockParamContentBetaCodeExecutionToolResultErrorBetaCodeExecutionToolResultErrorCodeBetaCodeExecutionToolResultErrorParamBetaCompact20260112EditBetaCompactionBlockBetaCompactionBlockParamBetaCompactionConfigBetaCompactionContentBlockDeltaBetaCompactionIterationUsageBetaComputerCursorPositionConfigBetaComputerDoubleClickConfigBetaComputerHoldKeyConfigBetaComputerKeyConfigBetaComputerLeftClickConfigBetaComputerLeftClickDragConfigBetaComputerLeftMouseDownConfigBetaComputerLeftMouseUpConfigBetaComputerMiddleClickConfigBetaComputerMouseMoveConfigBetaComputerRightClickConfigBetaComputerScreenshotConfigBetaComputerScrollConfigBetaComputerToolset20260801BetaComputerToolsetConfigsBetaComputerTripleClickConfigBetaComputerTypeConfigBetaComputerWaitConfigBetaComputerZoomConfigBetaContainerBetaContainerParamsBetaContainerSkillBetaContainerUploadBlockBetaContainerUploadBlockParamBetaContentBlockBetaContentBlockParamBetaContentBlockSourceBetaContentBlockSourceContentBetaContextManagementConfigBetaContextManagementResponseBetaCountTokensContextManagementResponseBetaDiagnosticsBetaDiagnosticsParamBetaDirectCallerBetaDocumentBlockBetaEncryptedCodeExecutionResultBlockBetaEncryptedCodeExecutionResultBlockParamBetaFallbackBlockBetaFallbackBlockParamBetaFallbackCreditNotAppliedBetaFallbackCreditRedeemedBetaFallbackCreditTokenParamBetaFallbackCreditUsageBetaFallbackInfoBetaFallbackInfoParamBetaFallbackMessageIterationUsageBetaFallbackParamBetaFallbackRefusalTriggerBetaFallbacksParamBetaFileDocumentSourceBetaFileImageSourceBetaImageBlockParamBetaImageTransformationsParamBetaInputJSONDeltaBetaJSONOutputFormatBetaInputTokensClearAtLeastBetaInputTokensTriggerBetaInputTransformationBetaIterationsUsageBetaJSONOutputFormatBetaMCPToolConfigBetaMCPToolDefaultConfigBetaMCPToolResultBlockBetaMCPToolUseBlockBetaMCPToolUseBlockParamBetaMCPToolsetBetaMemoryTool20250818BetaMemoryTool20250818CommandBetaMemoryTool20250818CreateCommandBetaMemoryTool20250818DeleteCommandBetaMemoryTool20250818InsertCommandBetaMemoryTool20250818RenameCommandBetaMemoryTool20250818StrReplaceCommandBetaMemoryTool20250818ViewCommandBetaMessageBetaMessageDeltaUsageBetaMessageIterationUsageBetaMessageParamBetaMessageTokensCountBetaMetadataBetaOutputConfigBetaOutputTokensDetailsBetaPlainTextSourceBetaRawContentBlockDeltaBetaRawContentBlockDeltaEventBetaRawContentBlockStartEventBetaRawContentBlockStopEventBetaRawMessageDeltaEventBetaRawMessageStartEventBetaRawMessageStopEventBetaRawMessageStreamEventBetaRedactedThinkingBlockBetaRedactedThinkingBlockParamBetaRefusalStopDetailsBetaRequestDocumentBlockBetaRequestMCPServerToolConfigurationBetaRequestMCPServerURLDefinitionBetaRequestMCPToolResultBlockParamBetaRequestToolAdditionBlockBetaRequestToolRemovalBlockBetaSearchResultBlockParamBetaServerToolCallerBetaServerToolCaller20260120BetaServerToolUsageBetaServerToolUseBlockBetaServerToolUseBlockParamBetaSignatureDeltaBetaSkillParamsBetaStopReasonBetaSummarizeCompactionBetaSystemMessageOutputConfigBetaTextBlockBetaTextBlockParamBetaTextCitationBetaTextCitationParamBetaTextDeltaBetaTextEditorCodeExecutionCreateResultBlockBetaTextEditorCodeExecutionCreateResultBlockParamBetaTextEditorCodeExecutionStrReplaceResultBlockBetaTextEditorCodeExecutionStrReplaceResultBlockParamBetaTextEditorCodeExecutionToolResultBlockBetaTextEditorCodeExecutionToolResultBlockParamBetaTextEditorCodeExecutionToolResultErrorBetaTextEditorCodeExecutionToolResultErrorParamBetaTextEditorCodeExecutionViewResultBlockBetaTextEditorCodeExecutionViewResultBlockParamBetaThinkingBlockBetaThinkingBlockBindingBetaThinkingBlockParamBetaThinkingConfigAdaptiveBetaThinkingConfigDisabledBetaThinkingConfigEnabledBetaThinkingConfigParamBetaThinkingDeltaBetaThinkingDroppedInputTransformationBetaThinkingMismatchAllowedInputTransformationBetaThinkingPrefixMismatchBehaviorBetaThinkingTurnsBetaTokenTaskBudgetBetaToolBetaToolBash20241022BetaToolBash20250124BetaToolChangeMCPToolReferenceBetaToolChangeMCPToolsetReferenceBetaToolChangeToolReferenceBetaToolChoiceBetaToolChoiceAnyBetaToolChoiceAutoBetaToolChoiceNoneBetaToolChoiceToolBetaToolComputerUse20241022BetaToolComputerUse20250124BetaToolComputerUse20251124BetaToolReferenceBlockBetaToolReferenceBlockParamBetaToolResultBlockParamBetaToolSearchToolBm25_20251119BetaToolSearchToolRegex20251119BetaToolSearchToolResultBlockBetaToolSearchToolResultBlockParamBetaToolSearchToolResultErrorBetaToolSearchToolResultErrorParamBetaToolSearchToolSearchResultBlockBetaToolSearchToolSearchResultBlockParamBetaToolTextEditor20241022BetaToolTextEditor20250124BetaToolTextEditor20250429BetaToolTextEditor20250728BetaToolUnionBetaToolUseBlockBetaToolUseBlockParamBetaToolUsesKeepBetaToolUsesTriggerBetaURLImageSourceBetaURLPDFSourceBetaUsageBetaUserLocationBetaWebFetchBlockBetaWebFetchBlockParamBetaWebFetchTool20250910BetaWebFetchTool20260209BetaWebFetchTool20260309BetaWebFetchTool20260318BetaWebFetchToolResultBlockBetaWebFetchToolResultBlockParamBetaWebFetchToolResultErrorBlockBetaWebFetchToolResultErrorBlockParamBetaWebFetchToolResultErrorCodeBetaWebFetchURLSourceAllBetaWebFetchURLSourceExceptBetaWebFetchURLSourceNoneBetaWebFetchURLSourceOnlyBetaWebFetchURLSourceToolReferenceBetaWebFetchURLSourcesBetaWebSearchResultBlockBetaWebSearchResultBlockParamBetaWebSearchTool20250305BetaWebSearchTool20260209BetaWebSearchTool20260318BetaWebSearchToolRequestErrorBetaWebSearchToolResultBlockBetaWebSearchToolResultBlockContentBetaWebSearchToolResultBlockParamBetaWebSearchToolResultBlockParamContentBetaWebSearchToolResultErrorBetaWebSearchToolResultErrorCodeBetaBase64PDFBlock
Methods:
client.beta.messages.create({ ...params }) -> BetaMessageclient.beta.messages.countTokens({ ...params }) -> BetaMessageTokensCount
Batches
Types:
BetaDeletedMessageBatchBetaMessageBatchBetaMessageBatchCanceledResultBetaMessageBatchErroredResultBetaMessageBatchExpiredResultBetaMessageBatchIndividualResponseBetaMessageBatchRequestCountsBetaMessageBatchResultBetaMessageBatchSucceededResult
Methods:
client.beta.messages.batches.create({ ...params }) -> BetaMessageBatchclient.beta.messages.batches.retrieve(messageBatchID, { ...params }) -> BetaMessageBatchclient.beta.messages.batches.list({ ...params }) -> BetaMessageBatchesPageclient.beta.messages.batches.delete(messageBatchID, { ...params }) -> BetaDeletedMessageBatchclient.beta.messages.batches.cancel(messageBatchID, { ...params }) -> BetaMessageBatchclient.beta.messages.batches.results(messageBatchID, { ...params }) -> BetaMessageBatchIndividualResponse
Agents
Types:
BetaManagedAgentsAdvisorBetaManagedAgentsAgentBetaManagedAgentsAgentReferenceBetaManagedAgentsAgentToolConfigBetaManagedAgentsAgentToolConfigParamsBetaManagedAgentsAgentToolsetDefaultConfigBetaManagedAgentsAgentToolsetDefaultConfigParamsBetaManagedAgentsAgentToolset20260401BetaManagedAgentsAgentToolset20260401BashInputBetaManagedAgentsAgentToolset20260401EditInputBetaManagedAgentsAgentToolset20260401GlobInputBetaManagedAgentsAgentToolset20260401GrepInputBetaManagedAgentsAgentToolset20260401ParamsBetaManagedAgentsAgentToolset20260401ReadInputBetaManagedAgentsAgentToolset20260401WriteInputBetaManagedAgentsAlwaysAllowPolicyBetaManagedAgentsAlwaysAskPolicyBetaManagedAgentsAnthropicSkillBetaManagedAgentsAnthropicSkillParamsBetaManagedAgentsAutoPolicyBetaManagedAgentsBashToolConfigBetaManagedAgentsBashToolConfigParamsBetaManagedAgentsCustomSkillBetaManagedAgentsCustomSkillParamsBetaManagedAgentsCustomToolBetaManagedAgentsCustomToolInputSchemaBetaManagedAgentsCustomToolParamsBetaManagedAgentsEditToolConfigBetaManagedAgentsEditToolConfigParamsBetaManagedAgentsEffortHighBetaManagedAgentsEffortLowBetaManagedAgentsEffortMaxBetaManagedAgentsEffortMediumBetaManagedAgentsEffortXhighBetaManagedAgentsGlobToolConfigBetaManagedAgentsGlobToolConfigParamsBetaManagedAgentsGrepToolConfigBetaManagedAgentsGrepToolConfigParamsBetaManagedAgentsMCPServerURLDefinitionBetaManagedAgentsMCPToolConfigBetaManagedAgentsMCPToolConfigParamsBetaManagedAgentsMCPToolsetBetaManagedAgentsMCPToolsetDefaultConfigBetaManagedAgentsMCPToolsetDefaultConfigParamsBetaManagedAgentsMCPToolsetParamsBetaManagedAgentsModelBetaManagedAgentsModelConfigBetaManagedAgentsModelConfigParamsBetaManagedAgentsMultiagentCoordinatorBetaManagedAgentsMultiagentCoordinatorParamsBetaManagedAgentsMultiagentSelfParamsBetaManagedAgentsReadToolConfigBetaManagedAgentsReadToolConfigParamsBetaManagedAgentsSessionThreadAgentBetaManagedAgentsSkillParamsBetaManagedAgentsURLMCPServerParamsBetaManagedAgentsUserLocationBetaManagedAgentsWebFetchToolConfigBetaManagedAgentsWebFetchToolConfigParamsBetaManagedAgentsWebSearchToolConfigBetaManagedAgentsWebSearchToolConfigParamsBetaManagedAgentsWriteToolConfigBetaManagedAgentsWriteToolConfigParams
Methods:
client.beta.agents.create({ ...params }) -> BetaManagedAgentsAgentclient.beta.agents.retrieve(agentID, { ...params }) -> BetaManagedAgentsAgentclient.beta.agents.update(agentID, { ...params }) -> BetaManagedAgentsAgentclient.beta.agents.list({ ...params }) -> BetaManagedAgentsAgentsPageCursorclient.beta.agents.archive(agentID, { ...params }) -> BetaManagedAgentsAgent
Versions
Methods:
client.beta.agents.versions.list(agentID, { ...params }) -> BetaManagedAgentsAgentsPageCursor
Environments
Types:
BetaCloudConfigBetaCloudConfigParamsBetaEnvironmentBetaEnvironmentDeleteResponseBetaLimitedNetworkBetaLimitedNetworkParamsBetaPackagesBetaPackagesParamsBetaSelfHostedConfigBetaSelfHostedConfigParamsBetaUnrestrictedNetwork
Methods:
client.beta.environments.create({ ...params }) -> BetaEnvironmentclient.beta.environments.retrieve(environmentID, { ...params }) -> BetaEnvironmentclient.beta.environments.update(environmentID, { ...params }) -> BetaEnvironmentclient.beta.environments.list({ ...params }) -> BetaEnvironmentsPageCursorclient.beta.environments.delete(environmentID, { ...params }) -> BetaEnvironmentDeleteResponseclient.beta.environments.archive(environmentID, { ...params }) -> BetaEnvironment
Work
Types:
BetaSelfHostedWorkBetaSelfHostedWorkHeartbeatResponseBetaSelfHostedWorkListResponseBetaSelfHostedWorkQueueStatsBetaSelfHostedWorkStopRequestBetaSelfHostedWorkUpdateRequestBetaSessionWorkData
Methods:
client.beta.environments.work.retrieve(workID, { ...params }) -> BetaSelfHostedWorkclient.beta.environments.work.update(workID, { ...params }) -> BetaSelfHostedWorkclient.beta.environments.work.list(environmentID, { ...params }) -> BetaSelfHostedWorksPageCursorclient.beta.environments.work.ack(workID, { ...params }) -> BetaSelfHostedWorkclient.beta.environments.work.heartbeat(workID, { ...params }) -> BetaSelfHostedWorkHeartbeatResponseclient.beta.environments.work.poll(environmentID, { ...params }) -> BetaSelfHostedWork | nullclient.beta.environments.work.stats(environmentID, { ...params }) -> BetaSelfHostedWorkQueueStatsclient.beta.environments.work.stop(workID, { ...params }) -> BetaSelfHostedWork
Sessions
Types:
BetaManagedAgentsAdvisorParamsBetaManagedAgentsAgentMessagePreviewBetaManagedAgentsAgentParamsBetaManagedAgentsAgentThinkingPreviewBetaManagedAgentsAgentWithOverridesParamsBetaManagedAgentsBranchCheckoutBetaManagedAgentsBudgetLimitBetaManagedAgentsCacheCreationUsageBetaManagedAgentsCommitCheckoutBetaManagedAgentsDeletedSessionBetaManagedAgentsDeltaContentBetaManagedAgentsDeltaEventBetaManagedAgentsDeltaTypeBetaManagedAgentsFileResourceParamsBetaManagedAgentsGitHubRepositoryResourceParamsBetaManagedAgentsMemoryStoreResourceParamBetaManagedAgentsMultiagentBetaManagedAgentsMultiagentParamsBetaManagedAgentsMultiagentRosterEntryParamsBetaManagedAgentsOutcomeEvaluationResourceBetaManagedAgentsServerToolUsageBetaManagedAgentsSessionBetaManagedAgentsSessionAgentBetaManagedAgentsSessionAgentUpdateBetaManagedAgentsSessionMultiagentCoordinatorBetaManagedAgentsSessionStatsBetaManagedAgentsSessionUpdatedEventBetaManagedAgentsSessionUsageBetaManagedAgentsSessionUsageEventBetaManagedAgentsStartEventBetaManagedAgentsStartEventPreviewBetaManagedAgentsSystemContentBlockBetaManagedAgentsSystemMessageEventBetaManagedAgentsUserToolResultEvent
Methods:
client.beta.sessions.create({ ...params }) -> BetaManagedAgentsSessionclient.beta.sessions.retrieve(sessionID, { ...params }) -> BetaManagedAgentsSessionclient.beta.sessions.update(sessionID, { ...params }) -> BetaManagedAgentsSessionclient.beta.sessions.list({ ...params }) -> BetaManagedAgentsSessionsBidirectionalPageCursorclient.beta.sessions.delete(sessionID, { ...params }) -> BetaManagedAgentsDeletedSessionclient.beta.sessions.archive(sessionID, { ...params }) -> BetaManagedAgentsSession
Events
Types:
BetaManagedAgentsAgentAutoEvaluatedPermissionBetaManagedAgentsAgentAutoEvaluatedPermissionAllowBetaManagedAgentsAgentAutoEvaluatedPermissionAskBetaManagedAgentsAgentAutoEvaluatedPermissionDenyBetaManagedAgentsAgentCustomToolUseEventBetaManagedAgentsAgentMCPToolResultEventBetaManagedAgentsAgentMCPToolUseEventBetaManagedAgentsAgentMessageEventBetaManagedAgentsAgentThinkingEventBetaManagedAgentsAgentThreadContextCompactedEventBetaManagedAgentsAgentThreadMessageReceivedEventBetaManagedAgentsAgentThreadMessageSentEventBetaManagedAgentsAgentToolEvaluationBetaManagedAgentsAgentToolEvaluationAlwaysAllowBetaManagedAgentsAgentToolEvaluationAlwaysAskBetaManagedAgentsAgentToolEvaluationAutoBetaManagedAgentsAgentToolResultEventBetaManagedAgentsAgentToolUseEventBetaManagedAgentsBase64DocumentSourceBetaManagedAgentsBase64ImageSourceBetaManagedAgentsBillingErrorBetaManagedAgentsCredentialHostUnreachableErrorBetaManagedAgentsDocumentBlockBetaManagedAgentsEventParamsBetaManagedAgentsFileDocumentSourceBetaManagedAgentsFileImageSourceBetaManagedAgentsFileRubricBetaManagedAgentsFileRubricParamsBetaManagedAgentsImageBlockBetaManagedAgentsMCPAuthenticationFailedErrorBetaManagedAgentsMCPConnectionFailedErrorBetaManagedAgentsModelOverloadedErrorBetaManagedAgentsModelRateLimitedErrorBetaManagedAgentsModelRequestFailedErrorBetaManagedAgentsPlainTextDocumentSourceBetaManagedAgentsRedactedBlockBetaManagedAgentsRetryStatusExhaustedBetaManagedAgentsRetryStatusRetryingBetaManagedAgentsRetryStatusTerminalBetaManagedAgentsSearchResultBlockBetaManagedAgentsSearchResultCitationsBetaManagedAgentsSearchResultContentBetaManagedAgentsSendSessionEventsBetaManagedAgentsSessionBudgetReachedBetaManagedAgentsSessionDeletedEventBetaManagedAgentsSessionEndTurnBetaManagedAgentsSessionErrorEventBetaManagedAgentsSessionEventBetaManagedAgentsSessionRequiresActionBetaManagedAgentsSessionRetriesExhaustedBetaManagedAgentsSessionStatusIdleEventBetaManagedAgentsSessionStatusRescheduledEventBetaManagedAgentsSessionStatusRunningEventBetaManagedAgentsSessionStatusTerminatedEventBetaManagedAgentsSessionThreadCreatedEventBetaManagedAgentsSessionThreadStatusIdleEventBetaManagedAgentsSessionThreadStatusRescheduledEventBetaManagedAgentsSessionThreadStatusRunningEventBetaManagedAgentsSessionThreadStatusTerminatedEventBetaManagedAgentsSessionUsageSnapshotBetaManagedAgentsSpanModelRequestEndEventBetaManagedAgentsSpanModelRequestStartEventBetaManagedAgentsSpanModelUsageBetaManagedAgentsSpanOutcomeEvaluationEndEventBetaManagedAgentsSpanOutcomeEvaluationOngoingEventBetaManagedAgentsSpanOutcomeEvaluationStartEventBetaManagedAgentsStreamSessionEventsBetaManagedAgentsSystemMessageEventParamsBetaManagedAgentsTextBlockBetaManagedAgentsTextRubricBetaManagedAgentsTextRubricParamsBetaManagedAgentsUnknownErrorBetaManagedAgentsURLDocumentSourceBetaManagedAgentsURLImageSourceBetaManagedAgentsUserCustomToolResultEventBetaManagedAgentsUserCustomToolResultEventParamsBetaManagedAgentsUserDefineOutcomeEventBetaManagedAgentsUserDefineOutcomeEventParamsBetaManagedAgentsUserInterruptEventBetaManagedAgentsUserInterruptEventParamsBetaManagedAgentsUserMessageEventBetaManagedAgentsUserMessageEventParamsBetaManagedAgentsUserToolConfirmationEventBetaManagedAgentsUserToolConfirmationEventParamsBetaManagedAgentsUserToolResultEventParams
Methods:
client.beta.sessions.events.list(sessionID, { ...params }) -> BetaManagedAgentsSessionEventsPageCursorclient.beta.sessions.events.send(sessionID, { ...params }) -> BetaManagedAgentsSendSessionEventsclient.beta.sessions.events.stream(sessionID, { ...params }) -> BetaManagedAgentsStreamSessionEvents
Resources
Types:
BetaManagedAgentsDeleteSessionResourceBetaManagedAgentsFileResourceBetaManagedAgentsGitHubRepositoryResourceBetaManagedAgentsMemoryStoreResourceBetaManagedAgentsSessionResourceResourceRetrieveResponseResourceUpdateResponse
Methods:
client.beta.sessions.resources.retrieve(resourceID, { ...params }) -> ResourceRetrieveResponseclient.beta.sessions.resources.update(resourceID, { ...params }) -> ResourceUpdateResponseclient.beta.sessions.resources.list(sessionID, { ...params }) -> BetaManagedAgentsSessionResourcesPageCursorclient.beta.sessions.resources.delete(resourceID, { ...params }) -> BetaManagedAgentsDeleteSessionResourceclient.beta.sessions.resources.add(sessionID, { ...params }) -> BetaManagedAgentsFileResource
Threads
Types:
BetaManagedAgentsSessionThreadBetaManagedAgentsSessionThreadStatsBetaManagedAgentsSessionThreadStatusBetaManagedAgentsSessionThreadUsageBetaManagedAgentsStreamSessionThreadEvents
Methods:
client.beta.sessions.threads.retrieve(threadID, { ...params }) -> BetaManagedAgentsSessionThreadclient.beta.sessions.threads.list(sessionID, { ...params }) -> BetaManagedAgentsSessionThreadsPageCursorclient.beta.sessions.threads.archive(threadID, { ...params }) -> BetaManagedAgentsSessionThread
Events
Methods:
client.beta.sessions.threads.events.list(threadID, { ...params }) -> BetaManagedAgentsSessionEventsPageCursorclient.beta.sessions.threads.events.stream(threadID, { ...params }) -> BetaManagedAgentsStreamSessionThreadEvents
Deployments
Types:
BetaManagedAgentsAgentArchivedDeploymentPausedReasonErrorBetaManagedAgentsCronScheduleBetaManagedAgentsCronScheduleParamsBetaManagedAgentsDeploymentBetaManagedAgentsDeploymentInitialEventBetaManagedAgentsDeploymentInitialEventParamsBetaManagedAgentsDeploymentPausedReasonBetaManagedAgentsDeploymentPausedReasonErrorBetaManagedAgentsDeploymentStatusBetaManagedAgentsDeploymentSystemMessageEventBetaManagedAgentsDeploymentUserDefineOutcomeEventBetaManagedAgentsDeploymentUserMessageEventBetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorBetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorBetaManagedAgentsErrorDeploymentPausedReasonBetaManagedAgentsFileNotFoundDeploymentPausedReasonErrorBetaManagedAgentsFileResourceConfigBetaManagedAgentsGitHubRepositoryResourceConfigBetaManagedAgentsManualDeploymentPausedReasonBetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorBetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorBetaManagedAgentsMemoryStoreResourceConfigBetaManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorBetaManagedAgentsScheduleBetaManagedAgentsScheduleParamsBetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorBetaManagedAgentsSessionResourceConfigBetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorBetaManagedAgentsSkillNotFoundDeploymentPausedReasonErrorBetaManagedAgentsUnknownDeploymentPausedReasonErrorBetaManagedAgentsVaultArchivedDeploymentPausedReasonErrorBetaManagedAgentsVaultNotFoundDeploymentPausedReasonErrorBetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError
Methods:
client.beta.deployments.create({ ...params }) -> BetaManagedAgentsDeploymentclient.beta.deployments.retrieve(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentclient.beta.deployments.update(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentclient.beta.deployments.list({ ...params }) -> BetaManagedAgentsDeploymentsPageCursorclient.beta.deployments.archive(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentclient.beta.deployments.pause(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentclient.beta.deployments.run(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentRunclient.beta.deployments.unpause(deploymentID, { ...params }) -> BetaManagedAgentsDeployment
DeploymentRuns
Types:
BetaManagedAgentsAgentArchivedRunErrorBetaManagedAgentsDeploymentRunBetaManagedAgentsEnvironmentArchivedRunErrorBetaManagedAgentsEnvironmentNotFoundRunErrorBetaManagedAgentsFileNotFoundRunErrorBetaManagedAgentsManualTriggerContextBetaManagedAgentsMCPEgressBlockedRunErrorBetaManagedAgentsMemoryStoreArchivedRunErrorBetaManagedAgentsOrganizationDisabledRunErrorBetaManagedAgentsScheduleTriggerContextBetaManagedAgentsSelfHostedResourcesUnsupportedRunErrorBetaManagedAgentsSessionCreationRejectedRunErrorBetaManagedAgentsSessionRateLimitedRunErrorBetaManagedAgentsSessionResourceNotFoundRunErrorBetaManagedAgentsSkillNotFoundRunErrorBetaManagedAgentsTriggerContextBetaManagedAgentsTriggerTypeBetaManagedAgentsUnknownRunErrorBetaManagedAgentsVaultArchivedRunErrorBetaManagedAgentsVaultNotFoundRunErrorBetaManagedAgentsWorkspaceArchivedRunError
Methods:
client.beta.deploymentRuns.retrieve(deploymentRunID, { ...params }) -> BetaManagedAgentsDeploymentRunclient.beta.deploymentRuns.list({ ...params }) -> BetaManagedAgentsDeploymentRunsPageCursor
Vaults
Types:
Methods:
client.beta.vaults.create({ ...params }) -> BetaManagedAgentsVaultclient.beta.vaults.retrieve(vaultID, { ...params }) -> BetaManagedAgentsVaultclient.beta.vaults.update(vaultID, { ...params }) -> BetaManagedAgentsVaultclient.beta.vaults.list({ ...params }) -> BetaManagedAgentsVaultsPageCursorclient.beta.vaults.delete(vaultID, { ...params }) -> BetaManagedAgentsDeletedVaultclient.beta.vaults.archive(vaultID, { ...params }) -> BetaManagedAgentsVault
Credentials
Types:
BetaManagedAgentsCredentialBetaManagedAgentsCredentialNetworkingParamsBetaManagedAgentsCredentialValidationBetaManagedAgentsCredentialValidationStatusBetaManagedAgentsDeletedCredentialBetaManagedAgentsEnvironmentVariableAuthResponseBetaManagedAgentsEnvironmentVariableCreateParamsBetaManagedAgentsEnvironmentVariableUpdateParamsBetaManagedAgentsInjectionLocationParamsBetaManagedAgentsInjectionLocationResponseBetaManagedAgentsInjectionLocationUpdateParamsBetaManagedAgentsLimitedCredentialNetworkingParamsBetaManagedAgentsLimitedCredentialNetworkingResponseBetaManagedAgentsMCPOAuthAuthResponseBetaManagedAgentsMCPOAuthCreateParamsBetaManagedAgentsMCPOAuthRefreshParamsBetaManagedAgentsMCPOAuthRefreshResponseBetaManagedAgentsMCPOAuthRefreshUpdateParamsBetaManagedAgentsMCPOAuthUpdateParamsBetaManagedAgentsMCPProbeBetaManagedAgentsRefreshHTTPResponseBetaManagedAgentsRefreshObjectBetaManagedAgentsStaticBearerAuthResponseBetaManagedAgentsStaticBearerCreateParamsBetaManagedAgentsStaticBearerUpdateParamsBetaManagedAgentsTokenEndpointAuthBasicParamBetaManagedAgentsTokenEndpointAuthBasicResponseBetaManagedAgentsTokenEndpointAuthBasicUpdateParamBetaManagedAgentsTokenEndpointAuthNoneParamBetaManagedAgentsTokenEndpointAuthNoneResponseBetaManagedAgentsTokenEndpointAuthPostParamBetaManagedAgentsTokenEndpointAuthPostResponseBetaManagedAgentsTokenEndpointAuthPostUpdateParamBetaManagedAgentsUnrestrictedCredentialNetworkingParamsBetaManagedAgentsUnrestrictedCredentialNetworkingResponse
Methods:
client.beta.vaults.credentials.create(vaultID, { ...params }) -> BetaManagedAgentsCredentialclient.beta.vaults.credentials.retrieve(credentialID, { ...params }) -> BetaManagedAgentsCredentialclient.beta.vaults.credentials.update(credentialID, { ...params }) -> BetaManagedAgentsCredentialclient.beta.vaults.credentials.list(vaultID, { ...params }) -> BetaManagedAgentsCredentialsPageCursorclient.beta.vaults.credentials.delete(credentialID, { ...params }) -> BetaManagedAgentsDeletedCredentialclient.beta.vaults.credentials.archive(credentialID, { ...params }) -> BetaManagedAgentsCredentialclient.beta.vaults.credentials.mcpOAuthValidate(credentialID, { ...params }) -> BetaManagedAgentsCredentialValidation
MemoryStores
Types:
Methods:
client.beta.memoryStores.create({ ...params }) -> BetaManagedAgentsMemoryStoreclient.beta.memoryStores.retrieve(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStoreclient.beta.memoryStores.update(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStoreclient.beta.memoryStores.list({ ...params }) -> BetaManagedAgentsMemoryStoresPageCursorclient.beta.memoryStores.delete(memoryStoreID, { ...params }) -> BetaManagedAgentsDeletedMemoryStoreclient.beta.memoryStores.archive(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStore
Memories
Types:
BetaManagedAgentsConflictErrorBetaManagedAgentsContentSha256PreconditionBetaManagedAgentsDeletedMemoryBetaManagedAgentsErrorBetaManagedAgentsMemoryBetaManagedAgentsMemoryListItemBetaManagedAgentsMemoryPathConflictErrorBetaManagedAgentsMemoryPreconditionFailedErrorBetaManagedAgentsMemoryPrefixBetaManagedAgentsMemoryViewBetaManagedAgentsPrecondition
Methods:
client.beta.memoryStores.memories.create(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryclient.beta.memoryStores.memories.retrieve(memoryID, { ...params }) -> BetaManagedAgentsMemoryclient.beta.memoryStores.memories.update(memoryID, { ...params }) -> BetaManagedAgentsMemoryclient.beta.memoryStores.memories.list(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryListItemsPageCursorclient.beta.memoryStores.memories.delete(memoryID, { ...params }) -> BetaManagedAgentsDeletedMemory
MemoryVersions
Types:
BetaManagedAgentsActorBetaManagedAgentsAPIActorBetaManagedAgentsMemoryVersionBetaManagedAgentsMemoryVersionOperationBetaManagedAgentsServiceAccountActorBetaManagedAgentsSessionActorBetaManagedAgentsUserActor
Methods:
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, { ...params }) -> BetaManagedAgentsMemoryVersionclient.beta.memoryStores.memoryVersions.list(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryVersionsPageCursorclient.beta.memoryStores.memoryVersions.redact(memoryVersionID, { ...params }) -> BetaManagedAgentsMemoryVersion
Files
Types:
Methods:
client.beta.files.list({ ...params }) -> BetaFileMetadataPageCursorclient.beta.files.delete(fileID, { ...params }) -> BetaDeletedFileclient.beta.files.download(fileID, { ...params }) -> Responseclient.beta.files.retrieveMetadata(fileID, { ...params }) -> BetaFileMetadataclient.beta.files.upload({ ...params }) -> BetaFileMetadata
Skills
Types:
Methods:
client.beta.skills.create({ ...params }) -> BetaSkillclient.beta.skills.retrieve(skillID, { ...params }) -> BetaSkillclient.beta.skills.list({ ...params }) -> BetaSkillsPageCursorclient.beta.skills.delete(skillID, { ...params }) -> BetaDeletedSkill
Versions
Types:
Methods:
client.beta.skills.versions.create(skillID, { ...params }) -> BetaSkillVersionclient.beta.skills.versions.retrieve(version, { ...params }) -> BetaSkillVersionclient.beta.skills.versions.list(skillID, { ...params }) -> BetaSkillVersionsPageCursorclient.beta.skills.versions.delete(version, { ...params }) -> BetaDeletedSkillVersionclient.beta.skills.versions.download(version, { ...params }) -> Response
Webhooks
Types:
BetaWebhookAgentArchivedEventDataBetaWebhookAgentCreatedEventDataBetaWebhookAgentDeletedEventDataBetaWebhookAgentUpdatedEventDataBetaWebhookDeploymentArchivedEventDataBetaWebhookDeploymentCreatedEventDataBetaWebhookDeploymentDeletedEventDataBetaWebhookDeploymentPausedEventDataBetaWebhookDeploymentRunFailedEventDataBetaWebhookDeploymentRunStartedEventDataBetaWebhookDeploymentRunSucceededEventDataBetaWebhookDeploymentUnpausedEventDataBetaWebhookDeploymentUpdatedEventDataBetaWebhookEnvironmentArchivedEventDataBetaWebhookEnvironmentCreatedEventDataBetaWebhookEnvironmentDeletedEventDataBetaWebhookEnvironmentUpdatedEventDataBetaWebhookEventBetaWebhookEventDataBetaWebhookMemoryStoreArchivedEventDataBetaWebhookMemoryStoreCreatedEventDataBetaWebhookMemoryStoreDeletedEventDataBetaWebhookSessionArchivedEventDataBetaWebhookSessionBudgetReachedEventDataBetaWebhookSessionCreatedEventDataBetaWebhookSessionDeletedEventDataBetaWebhookSessionIdledEventDataBetaWebhookSessionOutcomeEvaluationEndedEventDataBetaWebhookSessionPendingEventDataBetaWebhookSessionRequiresActionEventDataBetaWebhookSessionRunningEventDataBetaWebhookSessionStatusIdledEventDataBetaWebhookSessionStatusRescheduledEventDataBetaWebhookSessionStatusRunStartedEventDataBetaWebhookSessionStatusTerminatedEventDataBetaWebhookSessionThreadCreatedEventDataBetaWebhookSessionThreadIdledEventDataBetaWebhookSessionThreadTerminatedEventDataBetaWebhookSessionUpdatedEventDataBetaWebhookVaultArchivedEventDataBetaWebhookVaultCreatedEventDataBetaWebhookVaultCredentialArchivedEventDataBetaWebhookVaultCredentialCreatedEventDataBetaWebhookVaultCredentialDeletedEventDataBetaWebhookVaultCredentialRefreshFailedEventDataBetaWebhookVaultDeletedEventDataUnwrapWebhookEvent
Methods:
client.beta.webhooks.parseUnverified(body) -> voidclient.beta.webhooks.unwrap(body) -> void
UserProfiles
Types:
BetaUserProfileBetaUserProfileEnrollmentURLBetaUserProfileExternalUserDetailsBetaUserProfileExternalUserDetailsParamsBetaUserProfileTrustGrant
Methods:
client.beta.userProfiles.create({ ...params }) -> BetaUserProfileclient.beta.userProfiles.retrieve(userProfileID, { ...params }) -> BetaUserProfileclient.beta.userProfiles.update(userProfileID, { ...params }) -> BetaUserProfileclient.beta.userProfiles.list({ ...params }) -> BetaUserProfilesPageCursorclient.beta.userProfiles.createEnrollmentURL(userProfileID, { ...params }) -> BetaUserProfileEnrollmentURL
Dreams
Types:
BetaDreamBetaDreamErrorBetaDreamInputBetaDreamMemoryStoreInputBetaDreamMemoryStoreOutputBetaDreamModelConfigBetaDreamModelConfigParamBetaDreamOutputBetaDreamSessionsInputBetaDreamStatusBetaDreamUsageBetaDreamingErrorBetaOutputBehaviorBetaOutputBehaviorCreateNewBetaOutputBehaviorUpdateExistingBetaTargetStoreHeldError
Methods:
client.beta.dreams.create({ ...params }) -> BetaDreamclient.beta.dreams.retrieve(dreamID, { ...params }) -> BetaDreamclient.beta.dreams.list({ ...params }) -> BetaDreamsPageCursorclient.beta.dreams.archive(dreamID, { ...params }) -> BetaDreamclient.beta.dreams.cancel(dreamID, { ...params }) -> BetaDream
Tunnels
Types:
Methods:
client.beta.tunnels.create({ ...params }) -> BetaTunnelclient.beta.tunnels.retrieve(tunnelID, { ...params }) -> BetaTunnelclient.beta.tunnels.list({ ...params }) -> BetaTunnelsPageCursorclient.beta.tunnels.archive(tunnelID, { ...params }) -> BetaTunnelclient.beta.tunnels.revealToken(tunnelID, { ...params }) -> BetaTunnelTokenclient.beta.tunnels.rotateToken(tunnelID, { ...params }) -> BetaTunnelToken
Certificates
Types:
Methods:
client.beta.tunnels.certificates.create(tunnelID, { ...params }) -> BetaTunnelCertificateclient.beta.tunnels.certificates.retrieve(certificateID, { ...params }) -> BetaTunnelCertificateclient.beta.tunnels.certificates.list(tunnelID, { ...params }) -> BetaTunnelCertificatesPageCursorclient.beta.tunnels.certificates.archive(certificateID, { ...params }) -> BetaTunnelCertificate
Organization
Types:
Methods:
client.beta.organization.retrieve() -> BetaOrganization
APIKeys
Types:
BetaAPIKeyBetaAPIKeyCreatedByBetaAPIKeyOrganizationScopeBetaAPIKeyServiceAccountActorBetaAPIKeyUserActorBetaAPIKeyWorkspaceScope
Methods:
client.beta.organization.apiKeys.retrieve(apiKeyID) -> BetaAPIKeyclient.beta.organization.apiKeys.update(apiKeyID, { ...params }) -> BetaAPIKeyclient.beta.organization.apiKeys.list({ ...params }) -> BetaAPIKeysPage
ExternalKeys
Types:
BetaAWSExternalKeyConfigBetaAzureExternalKeyConfigBetaAzureExternalKeyConfigParamBetaExternalKeyBetaExternalKeyAttachedAttachmentBetaExternalKeyUnattachedAttachmentBetaGCPExternalKeyConfigExternalKeyDeleteResponseExternalKeyValidateResponse
Methods:
client.beta.organization.externalKeys.create({ ...params }) -> BetaExternalKeyclient.beta.organization.externalKeys.retrieve(externalKeyID) -> BetaExternalKeyclient.beta.organization.externalKeys.update(externalKeyID, { ...params }) -> BetaExternalKeyclient.beta.organization.externalKeys.list({ ...params }) -> BetaExternalKeysPageCursorclient.beta.organization.externalKeys.delete(externalKeyID) -> ExternalKeyDeleteResponseclient.beta.organization.externalKeys.validate(externalKeyID) -> ExternalKeyValidateResponse
Federation
Issuers
Types:
BetaFederationIssuerBetaFederationIssuerPollStatusBetaJWKSDiscoveryBetaJWKSExplicitURLBetaJWKSInline
Methods:
client.beta.organization.federation.issuers.create({ ...params }) -> BetaFederationIssuerclient.beta.organization.federation.issuers.retrieve(federationIssuerID, { ...params }) -> BetaFederationIssuerclient.beta.organization.federation.issuers.update(federationIssuerID, { ...params }) -> BetaFederationIssuerclient.beta.organization.federation.issuers.list({ ...params }) -> BetaFederationIssuersPageCursorclient.beta.organization.federation.issuers.archive(federationIssuerID, { ...params }) -> BetaFederationIssuer
Rules
Types:
Methods:
client.beta.organization.federation.rules.create({ ...params }) -> BetaFederationRuleclient.beta.organization.federation.rules.retrieve(federationRuleID, { ...params }) -> BetaFederationRuleclient.beta.organization.federation.rules.update(federationRuleID, { ...params }) -> BetaFederationRuleclient.beta.organization.federation.rules.list({ ...params }) -> BetaFederationRulesPageCursorclient.beta.organization.federation.rules.archive(federationRuleID, { ...params }) -> BetaFederationRule
Workspaces
Types:
Methods:
client.beta.organization.federation.rules.workspaces.list(federationRuleID, { ...params }) -> BetaFederationRuleWorkspacesPageCursorclient.beta.organization.federation.rules.workspaces.add(federationRuleID, { ...params }) -> BetaFederationRuleWorkspaceclient.beta.organization.federation.rules.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse
Invites
Types:
Methods:
client.beta.organization.invites.create({ ...params }) -> BetaOrganizationInviteclient.beta.organization.invites.retrieve(inviteID) -> BetaOrganizationInviteclient.beta.organization.invites.list({ ...params }) -> BetaOrganizationInvitesPageclient.beta.organization.invites.delete(inviteID) -> InviteDeleteResponse
ServiceAccounts
Types:
Methods:
client.beta.organization.serviceAccounts.create({ ...params }) -> BetaServiceAccountclient.beta.organization.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccountclient.beta.organization.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccountclient.beta.organization.serviceAccounts.list({ ...params }) -> BetaServiceAccountsPageCursorclient.beta.organization.serviceAccounts.archive(serviceAccountID, { ...params }) -> BetaServiceAccount
Workspaces
Types:
Methods:
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursorclient.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMemberclient.beta.organization.serviceAccounts.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse
Users
Types:
Methods:
client.beta.organization.users.retrieve(userID) -> BetaOrganizationUserclient.beta.organization.users.update(userID, { ...params }) -> BetaOrganizationUserclient.beta.organization.users.list({ ...params }) -> BetaOrganizationUsersPageclient.beta.organization.users.remove(userID) -> UserRemoveResponse
Workspaces
Types:
BetaAllowedInferenceGeoBetaDataResidencyBetaDataResidencyCreateConfigBetaDataResidencyUpdateConfigBetaNoBillingWorkspaceRoleBetaWorkspaceBetaWorkspaceMemberBetaWorkspaceRole
Methods:
client.beta.organization.workspaces.create({ ...params }) -> BetaWorkspaceclient.beta.organization.workspaces.retrieve(workspaceID) -> BetaWorkspaceclient.beta.organization.workspaces.update(workspaceID, { ...params }) -> BetaWorkspaceclient.beta.organization.workspaces.list({ ...params }) -> BetaWorkspacesPageclient.beta.organization.workspaces.archive(workspaceID) -> BetaWorkspace
RateLimits
Types:
Methods:
client.beta.organization.workspaces.rateLimits.list(workspaceID, { ...params }) -> BetaWorkspaceRateLimitsPageCursor
Members
Types:
Methods:
client.beta.organization.workspaces.members.retrieve(userID, { ...params }) -> BetaWorkspaceMemberclient.beta.organization.workspaces.members.update(userID, { ...params }) -> BetaWorkspaceMemberclient.beta.organization.workspaces.members.list(workspaceID, { ...params }) -> BetaWorkspaceMembersPageclient.beta.organization.workspaces.members.add(workspaceID, { ...params }) -> BetaWorkspaceMemberclient.beta.organization.workspaces.members.remove(userID, { ...params }) -> MemberRemoveResponse
ServiceAccounts
Types:
Methods:
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMemberclient.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMemberclient.beta.organization.workspaces.serviceAccounts.list(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursorclient.beta.organization.workspaces.serviceAccounts.add(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMemberclient.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, { ...params }) -> ServiceAccountRemoveResponse
RateLimits
Types:
BetaOrganizationRateLimitBetaOrganizationRateLimitBatchGroupBetaOrganizationRateLimitFilesGroupBetaOrganizationRateLimitModelGroupBetaOrganizationRateLimitSkillsGroupBetaOrganizationRateLimitTokenCountGroupBetaOrganizationRateLimitValueBetaOrganizationRateLimitWebSearchGroup
Methods:
client.beta.organization.rateLimits.list({ ...params }) -> BetaOrganizationRateLimitsPageCursor
ComplianceSettings
Types:
BetaComplianceSettingsBetaComplianceSettingsStateBetaComplianceSettingsStateDisabledBetaComplianceSettingsStateDisabledParamBetaComplianceSettingsStateEnabledBetaComplianceSettingsStateEnabledParamBetaComplianceSettingsStateParam
Methods: