Claude Platform Docs

Beta

Models
AnthropicBeta = String | :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more
One of the following:
class BetaAPIError { message, type }
message: String
type: :api_error
class BetaAuthenticationError { message, type }
message: String
type: :authentication_error
class BetaBillingError { message, type }
message: String
type: :billing_error
BetaCurrency = :USD
BetaError = BetaInvalidRequestError { message, type } | BetaAuthenticationError { message, type } | BetaBillingError { message, type } | 6 more
One of the following:
class BetaErrorResponse { error, request_id, type }
error: BetaError
One of the following:
request_id: String
type: :error
class BetaGatewayTimeoutError { message, type }
message: String
type: :timeout_error
class BetaInvalidRequestError { message, type }
message: String
type: :invalid_request_error
class BetaMonetaryAmount { amount, currency }

A monetary amount in a specific currency.

amount: String

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

class BetaNotFoundError { message, type }
message: String
type: :not_found_error
class BetaOverloadedError { message, type }
message: String
type: :overloaded_error
class BetaPermissionError { message, type }
message: String
type: :permission_error
class BetaRateLimitError { message, type }
message: String
type: :rate_limit_error

BetaModels

List Models
beta.models.list(**kwargs) -> Page<BetaModelInfo>
GET/v1/models
Get a Model
beta.models.retrieve(model_id, **kwargs) -> BetaModelInfo
GET/v1/models/{model_id}

BetaMessages

Create a Message
beta.messages.create(**kwargs) -> BetaMessage
POST/v1/messages
Count tokens in a Message
beta.messages.count_tokens(**kwargs) -> BetaMessageTokensCount
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
beta.messages.batches.create(**kwargs) -> BetaMessageBatch
POST/v1/messages/batches
Retrieve a Message Batch
beta.messages.batches.retrieve(message_batch_id, **kwargs) -> BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
beta.messages.batches.list(**kwargs) -> Page<BetaMessageBatch>
GET/v1/messages/batches
Cancel a Message Batch
beta.messages.batches.cancel(message_batch_id, **kwargs) -> BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
beta.messages.batches.delete(message_batch_id, **kwargs) -> BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results

BetaAgents

Create Agent
beta.agents.create(**kwargs) -> BetaManagedAgentsAgent
POST/v1/agents
List Agents
beta.agents.list(**kwargs) -> PageCursor<BetaManagedAgentsAgent>
GET/v1/agents
Get Agent
beta.agents.retrieve(agent_id, **kwargs) -> BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
Update Agent
beta.agents.update(agent_id, **kwargs) -> BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
Archive Agent
beta.agents.archive(agent_id, **kwargs) -> BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
beta.agents.versions.list(agent_id, **kwargs) -> PageCursor<BetaManagedAgentsAgent>
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
beta.environments.create(**kwargs) -> BetaEnvironment
POST/v1/environments
List Environments
beta.environments.list(**kwargs) -> PageCursor<BetaEnvironment>
GET/v1/environments
Get Environment
beta.environments.retrieve(environment_id, **kwargs) -> BetaEnvironment
GET/v1/environments/{environment_id}
Update Environment
beta.environments.update(environment_id, **kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}
Delete Environment
beta.environments.delete(environment_id, **kwargs) -> BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}
Archive Environment
beta.environments.archive(environment_id, **kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

Get Work Item
beta.environments.work.retrieve(work_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}
Poll for Work
beta.environments.work.poll(environment_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/poll
Acknowledge Work
beta.environments.work.ack(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack
Record Heartbeat
beta.environments.work.heartbeat(work_id, **kwargs) -> BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Stop Work
beta.environments.work.stop(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop
List Work Items
beta.environments.work.list(environment_id, **kwargs) -> PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work
Update Work Item
beta.environments.work.update(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}
Get Queue Statistics
beta.environments.work.stats(environment_id, **kwargs) -> BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

BetaSessions

Create Session
beta.sessions.create(**kwargs) -> BetaManagedAgentsSession
POST/v1/sessions
List Sessions
beta.sessions.list(**kwargs) -> BidirectionalPageCursor<BetaManagedAgentsSession>
GET/v1/sessions
Get Session
beta.sessions.retrieve(session_id, **kwargs) -> BetaManagedAgentsSession
GET/v1/sessions/{session_id}
Update Session
beta.sessions.update(session_id, **kwargs) -> BetaManagedAgentsSession
POST/v1/sessions/{session_id}
Delete Session
beta.sessions.delete(session_id, **kwargs) -> BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
Archive Session
beta.sessions.archive(session_id, **kwargs) -> BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
beta.sessions.events.list(session_id, **kwargs) -> PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
Send Events
beta.sessions.events.send_(session_id, **kwargs) -> BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Stream Events
beta.sessions.events.stream(session_id, **kwargs) -> BetaManagedAgentsStreamSessionEvents
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
beta.sessions.resources.add(session_id, **kwargs) -> BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
List Session Resources
beta.sessions.resources.list(session_id, **kwargs) -> PageCursor<BetaManagedAgentsSessionResource>
GET/v1/sessions/{session_id}/resources
Get Session Resource
beta.sessions.resources.retrieve(resource_id, **kwargs) -> ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
beta.sessions.resources.update(resource_id, **kwargs) -> ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
beta.sessions.resources.delete(resource_id, **kwargs) -> BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
beta.sessions.threads.list(session_id, **kwargs) -> PageCursor<BetaManagedAgentsSessionThread>
GET/v1/sessions/{session_id}/threads
Get Session Thread
beta.sessions.threads.retrieve(thread_id, **kwargs) -> BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
beta.sessions.threads.archive(thread_id, **kwargs) -> BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
beta.sessions.threads.events.list(thread_id, **kwargs) -> PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
beta.sessions.threads.events.stream(thread_id, **kwargs) -> BetaManagedAgentsStreamSessionThreadEvents
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
beta.deployments.create(**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments
List Deployments
beta.deployments.list(**kwargs) -> PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
Get Deployment
beta.deployments.retrieve(deployment_id, **kwargs) -> BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Update Deployment
beta.deployments.update(deployment_id, **kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Archive Deployment
beta.deployments.archive(deployment_id, **kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
beta.deployments.run(deployment_id, **kwargs) -> BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Pause Deployment
beta.deployments.pause(deployment_id, **kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
beta.deployments.unpause(deployment_id, **kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
beta.deployment_runs.list(**kwargs) -> PageCursor<BetaManagedAgentsDeploymentRun>
GET/v1/deployment_runs
Get Deployment Run
beta.deployment_runs.retrieve(deployment_run_id, **kwargs) -> BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
beta.vaults.create(**kwargs) -> BetaManagedAgentsVault
POST/v1/vaults
List Vaults
beta.vaults.list(**kwargs) -> PageCursor<BetaManagedAgentsVault>
GET/v1/vaults
Get Vault
beta.vaults.retrieve(vault_id, **kwargs) -> BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
Update Vault
beta.vaults.update(vault_id, **kwargs) -> BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
Delete Vault
beta.vaults.delete(vault_id, **kwargs) -> BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
Archive Vault
beta.vaults.archive(vault_id, **kwargs) -> BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
beta.vaults.credentials.create(vault_id, **kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
List Credentials
beta.vaults.credentials.list(vault_id, **kwargs) -> PageCursor<BetaManagedAgentsCredential>
GET/v1/vaults/{vault_id}/credentials
Get Credential
beta.vaults.credentials.retrieve(credential_id, **kwargs) -> BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
beta.vaults.credentials.update(credential_id, **kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
beta.vaults.credentials.delete(credential_id, **kwargs) -> BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
beta.vaults.credentials.archive(credential_id, **kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
beta.vaults.credentials.mcp_oauth_validate(credential_id, **kwargs) -> BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
beta.memory_stores.create(**kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores
List memory stores
beta.memory_stores.list(**kwargs) -> PageCursor<BetaManagedAgentsMemoryStore>
GET/v1/memory_stores
Retrieve a memory store
beta.memory_stores.retrieve(memory_store_id, **kwargs) -> BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
Update a memory store
beta.memory_stores.update(memory_store_id, **kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
beta.memory_stores.delete(memory_store_id, **kwargs) -> BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
beta.memory_stores.archive(memory_store_id, **kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
beta.memory_stores.memories.create(memory_store_id, **kwargs) -> BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
List memories
beta.memory_stores.memories.list(memory_store_id, **kwargs) -> PageCursor<BetaManagedAgentsMemoryListItem>
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
beta.memory_stores.memories.retrieve(memory_id, **kwargs) -> BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
beta.memory_stores.memories.update(memory_id, **kwargs) -> BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
beta.memory_stores.memories.delete(memory_id, **kwargs) -> BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
beta.memory_stores.memory_versions.list(memory_store_id, **kwargs) -> PageCursor<BetaManagedAgentsMemoryVersion>
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
beta.memory_stores.memory_versions.retrieve(memory_version_id, **kwargs) -> BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
beta.memory_stores.memory_versions.redact(memory_version_id, **kwargs) -> BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
beta.files.upload(**kwargs) -> BetaFileMetadata
POST/v1/files
List Files
beta.files.list(**kwargs) -> PageCursor<BetaFileMetadata>
GET/v1/files
Download File
beta.files.download(file_id, **kwargs) -> StringIO
GET/v1/files/{file_id}/content
Get File Metadata
beta.files.retrieve_metadata(file_id, **kwargs) -> BetaFileMetadata
GET/v1/files/{file_id}
Delete File
beta.files.delete(file_id, **kwargs) -> BetaDeletedFile
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
beta.skills.create(**kwargs) -> BetaSkill
POST/v1/skills
List Skills
beta.skills.list(**kwargs) -> PageCursor<BetaSkill>
GET/v1/skills
Get Skill
beta.skills.retrieve(skill_id, **kwargs) -> BetaSkill
GET/v1/skills/{skill_id}
Delete Skill
beta.skills.delete(skill_id, **kwargs) -> BetaDeletedSkill
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
beta.skills.versions.create(skill_id, **kwargs) -> BetaSkillVersion
POST/v1/skills/{skill_id}/versions
List Skill Versions
beta.skills.versions.list(skill_id, **kwargs) -> PageCursor<BetaSkillVersion>
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
beta.skills.versions.download(version, **kwargs) -> StringIO
GET/v1/skills/{skill_id}/versions/{version}/content
Get Skill Version
beta.skills.versions.retrieve(version, **kwargs) -> BetaSkillVersion
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
beta.skills.versions.delete(version, **kwargs) -> BetaDeletedSkillVersion
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
beta.webhooks.unwrap() -> void
Parse Unverified
beta.webhooks.parse_unverified() -> void

BetaUser Profiles

Create User Profile
beta.user_profiles.create(**kwargs) -> BetaUserProfile
POST/v1/user_profiles
List User Profiles
beta.user_profiles.list(**kwargs) -> PageCursor<BetaUserProfile>
GET/v1/user_profiles
Get User Profile
beta.user_profiles.retrieve(user_profile_id, **kwargs) -> BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Update User Profile
beta.user_profiles.update(user_profile_id, **kwargs) -> BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
beta.user_profiles.create_enrollment_url(user_profile_id, **kwargs) -> BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
beta.dreams.create(**kwargs) -> BetaDream
POST/v1/dreams
List Dreams
beta.dreams.list(**kwargs) -> PageCursor<BetaDream>
GET/v1/dreams
Get a Dream
beta.dreams.retrieve(dream_id, **kwargs) -> BetaDream
GET/v1/dreams/{dream_id}
Cancel a Dream
beta.dreams.cancel(dream_id, **kwargs) -> BetaDream
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
beta.dreams.archive(dream_id, **kwargs) -> BetaDream
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
beta.tunnels.create(**kwargs) -> BetaTunnel
POST/v1/tunnels
Get Tunnel
beta.tunnels.retrieve(tunnel_id, **kwargs) -> BetaTunnel
GET/v1/tunnels/{tunnel_id}
List Tunnels
beta.tunnels.list(**kwargs) -> PageCursor<BetaTunnel>
GET/v1/tunnels
Archive Tunnel
beta.tunnels.archive(tunnel_id, **kwargs) -> BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
beta.tunnels.reveal_token(tunnel_id, **kwargs) -> BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
beta.tunnels.rotate_token(tunnel_id, **kwargs) -> BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
beta.tunnels.certificates.create(tunnel_id, **kwargs) -> BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
beta.tunnels.certificates.retrieve(certificate_id, **kwargs) -> BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
beta.tunnels.certificates.list(tunnel_id, **kwargs) -> PageCursor<BetaTunnelCertificate>
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
beta.tunnels.certificates.archive(certificate_id, **kwargs) -> BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
beta.organization.retrieve() -> BetaOrganization
GET/v1/organizations/me

BetaOrganizationAPI Keys

List API Keys
beta.organization.api_keys.list(**kwargs) -> Page<BetaAPIKey>
GET/v1/organizations/api_keys
Get API Key
beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
beta.organization.external_keys.create(**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys
List External Keys
beta.organization.external_keys.list(**kwargs) -> PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys
Get External Key
beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
beta.organization.federation.issuers.create(**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers
List Federation Issuers
beta.organization.federation.issuers.list(**kwargs) -> PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers
Get Federation Issuer
beta.organization.federation.issuers.retrieve(federation_issuer_id, **kwargs) -> BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
beta.organization.federation.issuers.update(federation_issuer_id, **kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
beta.organization.federation.issuers.archive(federation_issuer_id, **kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
beta.organization.federation.rules.create(**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules
List Federation Rules
beta.organization.federation.rules.list(**kwargs) -> PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules
Get Federation Rule
beta.organization.federation.rules.retrieve(federation_rule_id, **kwargs) -> BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
beta.organization.federation.rules.archive(federation_rule_id, **kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
beta.organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
beta.organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> PageCursor<BetaFederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
beta.organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite
POST/v1/organizations/invites
List Invites
beta.organization.invites.list(**kwargs) -> Page<BetaOrganizationInvite>
GET/v1/organizations/invites
Get Invite
beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}
Delete Invite
beta.organization.invites.delete(invite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
beta.organization.service_accounts.create(**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts
List Service Accounts
beta.organization.service_accounts.list(**kwargs) -> PageCursor<BetaServiceAccount>
GET/v1/organizations/service_accounts
Get Service Account
beta.organization.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
beta.organization.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
beta.organization.service_accounts.archive(service_account_id, **kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
beta.organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
beta.organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
beta.organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
beta.organization.users.list(**kwargs) -> Page<BetaOrganizationUser>
GET/v1/organizations/users
Get User
beta.organization.users.retrieve(user_id) -> BetaOrganizationUser
GET/v1/organizations/users/{user_id}
Update User
beta.organization.users.update(user_id, **kwargs) -> BetaOrganizationUser
POST/v1/organizations/users/{user_id}
Remove User
beta.organization.users.remove(user_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

BetaOrganizationWorkspaces

List Workspaces
beta.organization.workspaces.list(**kwargs) -> Page<BetaWorkspace>
GET/v1/organizations/workspaces
Create Workspace
beta.organization.workspaces.create(**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
beta.organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizationWorkspacesMembers

List Workspace Members
beta.organization.workspaces.members.list(workspace_id, **kwargs) -> Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
beta.organization.workspaces.members.add(workspace_id, **kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
beta.organization.workspaces.members.retrieve(user_id, **kwargs) -> BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
beta.organization.workspaces.members.update(user_id, **kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
beta.organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
beta.organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
beta.organization.rate_limits.list(**kwargs) -> PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits