SPB Git

Repository Public

node-sdk-api.md 149.5 KB

# Anthropic

# Shared

Types:

# Messages

Types:

Methods:

  • client.messages.create({ ...params }) -> Message
  • client.messages.countTokens({ ...params }) -> MessageTokensCount
  • client.messages.stream(body, options?) -> MessageStream

# Batches

Types:

Methods:

  • client.messages.batches.create({ ...params }) -> MessageBatch
  • client.messages.batches.retrieve(messageBatchID, { ...params }) -> MessageBatch
  • client.messages.batches.list({ ...params }) -> MessageBatchesPage
  • client.messages.batches.delete(messageBatchID, { ...params }) -> DeletedMessageBatch
  • client.messages.batches.cancel(messageBatchID, { ...params }) -> MessageBatch
  • client.messages.batches.results(messageBatchID, { ...params }) -> MessageBatchIndividualResponse

# Models

Types:

Methods:

  • client.models.retrieve(modelID, { ...params }) -> ModelInfo
  • client.models.list({ ...params }) -> ModelInfosPage

# Files

Types:

Methods:

  • client.files.list({ ...params }) -> FileMetadataPageCursor
  • client.files.delete(fileID, { ...params }) -> DeletedFile
  • client.files.download(fileID, { ...params }) -> Response
  • client.files.retrieveMetadata(fileID, { ...params }) -> FileMetadata
  • client.files.upload({ ...params }) -> FileMetadata

# Skills

Types:

Methods:

  • client.skills.create({ ...params }) -> Skill
  • client.skills.retrieve(skillID, { ...params }) -> Skill
  • client.skills.list({ ...params }) -> SkillsPageCursor
  • client.skills.delete(skillID, { ...params }) -> DeletedSkill

# Versions

Types:

Methods:

  • client.skills.versions.create(skillID, { ...params }) -> SkillVersion
  • client.skills.versions.retrieve(version, { ...params }) -> SkillVersion
  • client.skills.versions.list(skillID, { ...params }) -> SkillVersionsPageCursor
  • client.skills.versions.delete(version, { ...params }) -> DeletedSkillVersion

# Beta

Types:

# Models

Types:

Methods:

  • client.beta.models.retrieve(modelID, { ...params }) -> BetaModelInfo
  • client.beta.models.list({ ...params }) -> BetaModelInfosPage

# Messages

Types:

Methods:

  • client.beta.messages.create({ ...params }) -> BetaMessage
  • client.beta.messages.countTokens({ ...params }) -> BetaMessageTokensCount

# Batches

Types:

Methods:

  • client.beta.messages.batches.create({ ...params }) -> BetaMessageBatch
  • client.beta.messages.batches.retrieve(messageBatchID, { ...params }) -> BetaMessageBatch
  • client.beta.messages.batches.list({ ...params }) -> BetaMessageBatchesPage
  • client.beta.messages.batches.delete(messageBatchID, { ...params }) -> BetaDeletedMessageBatch
  • client.beta.messages.batches.cancel(messageBatchID, { ...params }) -> BetaMessageBatch
  • client.beta.messages.batches.results(messageBatchID, { ...params }) -> BetaMessageBatchIndividualResponse

# Agents

Types:

Methods:

  • client.beta.agents.create({ ...params }) -> BetaManagedAgentsAgent
  • client.beta.agents.retrieve(agentID, { ...params }) -> BetaManagedAgentsAgent
  • client.beta.agents.update(agentID, { ...params }) -> BetaManagedAgentsAgent
  • client.beta.agents.list({ ...params }) -> BetaManagedAgentsAgentsPageCursor
  • client.beta.agents.archive(agentID, { ...params }) -> BetaManagedAgentsAgent

# Versions

Methods:

  • client.beta.agents.versions.list(agentID, { ...params }) -> BetaManagedAgentsAgentsPageCursor

# Environments

Types:

Methods:

  • client.beta.environments.create({ ...params }) -> BetaEnvironment
  • client.beta.environments.retrieve(environmentID, { ...params }) -> BetaEnvironment
  • client.beta.environments.update(environmentID, { ...params }) -> BetaEnvironment
  • client.beta.environments.list({ ...params }) -> BetaEnvironmentsPageCursor
  • client.beta.environments.delete(environmentID, { ...params }) -> BetaEnvironmentDeleteResponse
  • client.beta.environments.archive(environmentID, { ...params }) -> BetaEnvironment

# Work

Types:

Methods:

  • client.beta.environments.work.retrieve(workID, { ...params }) -> BetaSelfHostedWork
  • client.beta.environments.work.update(workID, { ...params }) -> BetaSelfHostedWork
  • client.beta.environments.work.list(environmentID, { ...params }) -> BetaSelfHostedWorksPageCursor
  • client.beta.environments.work.ack(workID, { ...params }) -> BetaSelfHostedWork
  • client.beta.environments.work.heartbeat(workID, { ...params }) -> BetaSelfHostedWorkHeartbeatResponse
  • client.beta.environments.work.poll(environmentID, { ...params }) -> BetaSelfHostedWork | null
  • client.beta.environments.work.stats(environmentID, { ...params }) -> BetaSelfHostedWorkQueueStats
  • client.beta.environments.work.stop(workID, { ...params }) -> BetaSelfHostedWork

# Sessions

Types:

Methods:

  • client.beta.sessions.create({ ...params }) -> BetaManagedAgentsSession
  • client.beta.sessions.retrieve(sessionID, { ...params }) -> BetaManagedAgentsSession
  • client.beta.sessions.update(sessionID, { ...params }) -> BetaManagedAgentsSession
  • client.beta.sessions.list({ ...params }) -> BetaManagedAgentsSessionsBidirectionalPageCursor
  • client.beta.sessions.delete(sessionID, { ...params }) -> BetaManagedAgentsDeletedSession
  • client.beta.sessions.archive(sessionID, { ...params }) -> BetaManagedAgentsSession

# Events

Types:

Methods:

  • client.beta.sessions.events.list(sessionID, { ...params }) -> BetaManagedAgentsSessionEventsPageCursor
  • client.beta.sessions.events.send(sessionID, { ...params }) -> BetaManagedAgentsSendSessionEvents
  • client.beta.sessions.events.stream(sessionID, { ...params }) -> BetaManagedAgentsStreamSessionEvents

# Resources

Types:

Methods:

  • client.beta.sessions.resources.retrieve(resourceID, { ...params }) -> ResourceRetrieveResponse
  • client.beta.sessions.resources.update(resourceID, { ...params }) -> ResourceUpdateResponse
  • client.beta.sessions.resources.list(sessionID, { ...params }) -> BetaManagedAgentsSessionResourcesPageCursor
  • client.beta.sessions.resources.delete(resourceID, { ...params }) -> BetaManagedAgentsDeleteSessionResource
  • client.beta.sessions.resources.add(sessionID, { ...params }) -> BetaManagedAgentsFileResource

# Threads

Types:

Methods:

  • client.beta.sessions.threads.retrieve(threadID, { ...params }) -> BetaManagedAgentsSessionThread
  • client.beta.sessions.threads.list(sessionID, { ...params }) -> BetaManagedAgentsSessionThreadsPageCursor
  • client.beta.sessions.threads.archive(threadID, { ...params }) -> BetaManagedAgentsSessionThread

# Events

Methods:

  • client.beta.sessions.threads.events.list(threadID, { ...params }) -> BetaManagedAgentsSessionEventsPageCursor
  • client.beta.sessions.threads.events.stream(threadID, { ...params }) -> BetaManagedAgentsStreamSessionThreadEvents

# Deployments

Types:

Methods:

  • client.beta.deployments.create({ ...params }) -> BetaManagedAgentsDeployment
  • client.beta.deployments.retrieve(deploymentID, { ...params }) -> BetaManagedAgentsDeployment
  • client.beta.deployments.update(deploymentID, { ...params }) -> BetaManagedAgentsDeployment
  • client.beta.deployments.list({ ...params }) -> BetaManagedAgentsDeploymentsPageCursor
  • client.beta.deployments.archive(deploymentID, { ...params }) -> BetaManagedAgentsDeployment
  • client.beta.deployments.pause(deploymentID, { ...params }) -> BetaManagedAgentsDeployment
  • client.beta.deployments.run(deploymentID, { ...params }) -> BetaManagedAgentsDeploymentRun
  • client.beta.deployments.unpause(deploymentID, { ...params }) -> BetaManagedAgentsDeployment

# DeploymentRuns

Types:

Methods:

  • client.beta.deploymentRuns.retrieve(deploymentRunID, { ...params }) -> BetaManagedAgentsDeploymentRun
  • client.beta.deploymentRuns.list({ ...params }) -> BetaManagedAgentsDeploymentRunsPageCursor

# Vaults

Types:

Methods:

  • client.beta.vaults.create({ ...params }) -> BetaManagedAgentsVault
  • client.beta.vaults.retrieve(vaultID, { ...params }) -> BetaManagedAgentsVault
  • client.beta.vaults.update(vaultID, { ...params }) -> BetaManagedAgentsVault
  • client.beta.vaults.list({ ...params }) -> BetaManagedAgentsVaultsPageCursor
  • client.beta.vaults.delete(vaultID, { ...params }) -> BetaManagedAgentsDeletedVault
  • client.beta.vaults.archive(vaultID, { ...params }) -> BetaManagedAgentsVault

# Credentials

Types:

Methods:

  • client.beta.vaults.credentials.create(vaultID, { ...params }) -> BetaManagedAgentsCredential
  • client.beta.vaults.credentials.retrieve(credentialID, { ...params }) -> BetaManagedAgentsCredential
  • client.beta.vaults.credentials.update(credentialID, { ...params }) -> BetaManagedAgentsCredential
  • client.beta.vaults.credentials.list(vaultID, { ...params }) -> BetaManagedAgentsCredentialsPageCursor
  • client.beta.vaults.credentials.delete(credentialID, { ...params }) -> BetaManagedAgentsDeletedCredential
  • client.beta.vaults.credentials.archive(credentialID, { ...params }) -> BetaManagedAgentsCredential
  • client.beta.vaults.credentials.mcpOAuthValidate(credentialID, { ...params }) -> BetaManagedAgentsCredentialValidation

# MemoryStores

Types:

Methods:

  • client.beta.memoryStores.create({ ...params }) -> BetaManagedAgentsMemoryStore
  • client.beta.memoryStores.retrieve(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStore
  • client.beta.memoryStores.update(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStore
  • client.beta.memoryStores.list({ ...params }) -> BetaManagedAgentsMemoryStoresPageCursor
  • client.beta.memoryStores.delete(memoryStoreID, { ...params }) -> BetaManagedAgentsDeletedMemoryStore
  • client.beta.memoryStores.archive(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryStore

# Memories

Types:

Methods:

  • client.beta.memoryStores.memories.create(memoryStoreID, { ...params }) -> BetaManagedAgentsMemory
  • client.beta.memoryStores.memories.retrieve(memoryID, { ...params }) -> BetaManagedAgentsMemory
  • client.beta.memoryStores.memories.update(memoryID, { ...params }) -> BetaManagedAgentsMemory
  • client.beta.memoryStores.memories.list(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryListItemsPageCursor
  • client.beta.memoryStores.memories.delete(memoryID, { ...params }) -> BetaManagedAgentsDeletedMemory

# MemoryVersions

Types:

Methods:

  • client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, { ...params }) -> BetaManagedAgentsMemoryVersion
  • client.beta.memoryStores.memoryVersions.list(memoryStoreID, { ...params }) -> BetaManagedAgentsMemoryVersionsPageCursor
  • client.beta.memoryStores.memoryVersions.redact(memoryVersionID, { ...params }) -> BetaManagedAgentsMemoryVersion

# Files

Types:

Methods:

  • client.beta.files.list({ ...params }) -> BetaFileMetadataPageCursor
  • client.beta.files.delete(fileID, { ...params }) -> BetaDeletedFile
  • client.beta.files.download(fileID, { ...params }) -> Response
  • client.beta.files.retrieveMetadata(fileID, { ...params }) -> BetaFileMetadata
  • client.beta.files.upload({ ...params }) -> BetaFileMetadata

# Skills

Types:

Methods:

  • client.beta.skills.create({ ...params }) -> BetaSkill
  • client.beta.skills.retrieve(skillID, { ...params }) -> BetaSkill
  • client.beta.skills.list({ ...params }) -> BetaSkillsPageCursor
  • client.beta.skills.delete(skillID, { ...params }) -> BetaDeletedSkill

# Versions

Types:

Methods:

  • client.beta.skills.versions.create(skillID, { ...params }) -> BetaSkillVersion
  • client.beta.skills.versions.retrieve(version, { ...params }) -> BetaSkillVersion
  • client.beta.skills.versions.list(skillID, { ...params }) -> BetaSkillVersionsPageCursor
  • client.beta.skills.versions.delete(version, { ...params }) -> BetaDeletedSkillVersion
  • client.beta.skills.versions.download(version, { ...params }) -> Response

# Webhooks

Types:

Methods:

# UserProfiles

Types:

Methods:

  • client.beta.userProfiles.create({ ...params }) -> BetaUserProfile
  • client.beta.userProfiles.retrieve(userProfileID, { ...params }) -> BetaUserProfile
  • client.beta.userProfiles.update(userProfileID, { ...params }) -> BetaUserProfile
  • client.beta.userProfiles.list({ ...params }) -> BetaUserProfilesPageCursor
  • client.beta.userProfiles.createEnrollmentURL(userProfileID, { ...params }) -> BetaUserProfileEnrollmentURL

# Dreams

Types:

Methods:

  • client.beta.dreams.create({ ...params }) -> BetaDream
  • client.beta.dreams.retrieve(dreamID, { ...params }) -> BetaDream
  • client.beta.dreams.list({ ...params }) -> BetaDreamsPageCursor
  • client.beta.dreams.archive(dreamID, { ...params }) -> BetaDream
  • client.beta.dreams.cancel(dreamID, { ...params }) -> BetaDream

# Tunnels

Types:

Methods:

  • client.beta.tunnels.create({ ...params }) -> BetaTunnel
  • client.beta.tunnels.retrieve(tunnelID, { ...params }) -> BetaTunnel
  • client.beta.tunnels.list({ ...params }) -> BetaTunnelsPageCursor
  • client.beta.tunnels.archive(tunnelID, { ...params }) -> BetaTunnel
  • client.beta.tunnels.revealToken(tunnelID, { ...params }) -> BetaTunnelToken
  • client.beta.tunnels.rotateToken(tunnelID, { ...params }) -> BetaTunnelToken

# Certificates

Types:

Methods:

  • client.beta.tunnels.certificates.create(tunnelID, { ...params }) -> BetaTunnelCertificate
  • client.beta.tunnels.certificates.retrieve(certificateID, { ...params }) -> BetaTunnelCertificate
  • client.beta.tunnels.certificates.list(tunnelID, { ...params }) -> BetaTunnelCertificatesPageCursor
  • client.beta.tunnels.certificates.archive(certificateID, { ...params }) -> BetaTunnelCertificate

# Organization

Types:

Methods:

  • client.beta.organization.retrieve() -> BetaOrganization

# APIKeys

Types:

Methods:

  • client.beta.organization.apiKeys.retrieve(apiKeyID) -> BetaAPIKey
  • client.beta.organization.apiKeys.update(apiKeyID, { ...params }) -> BetaAPIKey
  • client.beta.organization.apiKeys.list({ ...params }) -> BetaAPIKeysPage

# ExternalKeys

Types:

Methods:

  • client.beta.organization.externalKeys.create({ ...params }) -> BetaExternalKey
  • client.beta.organization.externalKeys.retrieve(externalKeyID) -> BetaExternalKey
  • client.beta.organization.externalKeys.update(externalKeyID, { ...params }) -> BetaExternalKey
  • client.beta.organization.externalKeys.list({ ...params }) -> BetaExternalKeysPageCursor
  • client.beta.organization.externalKeys.delete(externalKeyID) -> ExternalKeyDeleteResponse
  • client.beta.organization.externalKeys.validate(externalKeyID) -> ExternalKeyValidateResponse

# Federation

# Issuers

Types:

Methods:

  • client.beta.organization.federation.issuers.create({ ...params }) -> BetaFederationIssuer
  • client.beta.organization.federation.issuers.retrieve(federationIssuerID, { ...params }) -> BetaFederationIssuer
  • client.beta.organization.federation.issuers.update(federationIssuerID, { ...params }) -> BetaFederationIssuer
  • client.beta.organization.federation.issuers.list({ ...params }) -> BetaFederationIssuersPageCursor
  • client.beta.organization.federation.issuers.archive(federationIssuerID, { ...params }) -> BetaFederationIssuer

# Rules

Types:

Methods:

  • client.beta.organization.federation.rules.create({ ...params }) -> BetaFederationRule
  • client.beta.organization.federation.rules.retrieve(federationRuleID, { ...params }) -> BetaFederationRule
  • client.beta.organization.federation.rules.update(federationRuleID, { ...params }) -> BetaFederationRule
  • client.beta.organization.federation.rules.list({ ...params }) -> BetaFederationRulesPageCursor
  • client.beta.organization.federation.rules.archive(federationRuleID, { ...params }) -> BetaFederationRule
# Workspaces

Types:

Methods:

  • client.beta.organization.federation.rules.workspaces.list(federationRuleID, { ...params }) -> BetaFederationRuleWorkspacesPageCursor
  • client.beta.organization.federation.rules.workspaces.add(federationRuleID, { ...params }) -> BetaFederationRuleWorkspace
  • client.beta.organization.federation.rules.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse

# Invites

Types:

Methods:

  • client.beta.organization.invites.create({ ...params }) -> BetaOrganizationInvite
  • client.beta.organization.invites.retrieve(inviteID) -> BetaOrganizationInvite
  • client.beta.organization.invites.list({ ...params }) -> BetaOrganizationInvitesPage
  • client.beta.organization.invites.delete(inviteID) -> InviteDeleteResponse

# ServiceAccounts

Types:

Methods:

  • client.beta.organization.serviceAccounts.create({ ...params }) -> BetaServiceAccount
  • client.beta.organization.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccount
  • client.beta.organization.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccount
  • client.beta.organization.serviceAccounts.list({ ...params }) -> BetaServiceAccountsPageCursor
  • client.beta.organization.serviceAccounts.archive(serviceAccountID, { ...params }) -> BetaServiceAccount

# Workspaces

Types:

Methods:

  • client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursor
  • client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember
  • client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse

# Users

Types:

Methods:

  • client.beta.organization.users.retrieve(userID) -> BetaOrganizationUser
  • client.beta.organization.users.update(userID, { ...params }) -> BetaOrganizationUser
  • client.beta.organization.users.list({ ...params }) -> BetaOrganizationUsersPage
  • client.beta.organization.users.remove(userID) -> UserRemoveResponse

# Workspaces

Types:

Methods:

  • client.beta.organization.workspaces.create({ ...params }) -> BetaWorkspace
  • client.beta.organization.workspaces.retrieve(workspaceID) -> BetaWorkspace
  • client.beta.organization.workspaces.update(workspaceID, { ...params }) -> BetaWorkspace
  • client.beta.organization.workspaces.list({ ...params }) -> BetaWorkspacesPage
  • client.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 }) -> BetaWorkspaceMember
  • client.beta.organization.workspaces.members.update(userID, { ...params }) -> BetaWorkspaceMember
  • client.beta.organization.workspaces.members.list(workspaceID, { ...params }) -> BetaWorkspaceMembersPage
  • client.beta.organization.workspaces.members.add(workspaceID, { ...params }) -> BetaWorkspaceMember
  • client.beta.organization.workspaces.members.remove(userID, { ...params }) -> MemberRemoveResponse

# ServiceAccounts

Types:

Methods:

  • client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember
  • client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember
  • client.beta.organization.workspaces.serviceAccounts.list(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursor
  • client.beta.organization.workspaces.serviceAccounts.add(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMember
  • client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, { ...params }) -> ServiceAccountRemoveResponse

# RateLimits

Types:

Methods:

  • client.beta.organization.rateLimits.list({ ...params }) -> BetaOrganizationRateLimitsPageCursor

# ComplianceSettings

Types:

Methods:

  • client.beta.organization.complianceSettings.retrieve() -> BetaComplianceSettings
  • client.beta.organization.complianceSettings.update({ ...params }) -> BetaComplianceSettings
Files main
Menu

Theme