Claude Platform Docs

Beta

Models
enum AnthropicBeta
class BetaApiError { type = "api_error"; message; }
JsonValue type = "api_error"
String message
class BetaAuthenticationError { type = "authentication_error"; message; }
JsonValue type = "authentication_error"
String message
class BetaBillingError { type = "billing_error"; message; }
JsonValue type = "billing_error"
String message
enum BetaCurrency
USD("USD")
class BetaError: union
class BetaErrorResponse { type = "error"; error; requestId; }
JsonValue type = "error"
BetaError error
One of the following:
Optional<String> requestId
class BetaGatewayTimeoutError { type = "timeout_error"; message; }
JsonValue type = "timeout_error"
String message
class BetaInvalidRequestError { type = "invalid_request_error"; message; }
JsonValue type = "invalid_request_error"
String message
class BetaMonetaryAmount { amount; currency; }

A monetary amount in a specific currency.

String amount

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.

BetaCurrency currency

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 { type = "not_found_error"; message; }
JsonValue type = "not_found_error"
String message
class BetaOverloadedError { type = "overloaded_error"; message; }
JsonValue type = "overloaded_error"
String message
class BetaPermissionError { type = "permission_error"; message; }
JsonValue type = "permission_error"
String message
class BetaRateLimitError { type = "rate_limit_error"; message; }
JsonValue type = "rate_limit_error"
String message

BetaModels

List Models
ModelListPage beta().models().list(params = ModelListParams.none(), requestOptions = RequestOptions.none())
GET/v1/models

List available models.

Get a Model
BetaModelInfo beta().models().retrieve(params = ModelRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/models/{model_id}

Get a specific model.

BetaMessages

Create a Message
BetaMessage beta().messages().create(params, requestOptions = RequestOptions.none())
POST/v1/messages

Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.

Count tokens in a Message
BetaMessageTokensCount beta().messages().countTokens(params, requestOptions = RequestOptions.none())
POST/v1/messages/count_tokens

Count the number of tokens in a Message.

BetaMessagesBatches

Create a Message Batch
BetaMessageBatch beta().messages().batches().create(params, requestOptions = RequestOptions.none())
POST/v1/messages/batches

Send a batch of Message creation requests.

Retrieve a Message Batch
BetaMessageBatch beta().messages().batches().retrieve(params = BatchRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}

This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url field in the response.

List Message Batches
BatchListPage beta().messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches

List all Message Batches within a Workspace. Most recently created batches are returned first.

Cancel a Message Batch
BetaMessageBatch beta().messages().batches().cancel(params = BatchCancelParams.none(), requestOptions = RequestOptions.none())
POST/v1/messages/batches/{message_batch_id}/cancel

Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a canceling state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation.

Delete a Message Batch
BetaDeletedMessageBatch beta().messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
StreamResponse<BetaMessageBatchIndividualResponse> beta().messages().batches().resultsStreaming(params = BatchResultsParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}/results

Streams the results of a Message Batch as a .jsonl file.

BetaAgents

Create Agent
BetaManagedAgentsAgent beta().agents().create(params, requestOptions = RequestOptions.none())
POST/v1/agents
List Agents
AgentListPage beta().agents().list(params = AgentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents
Get Agent
BetaManagedAgentsAgent beta().agents().retrieve(params = AgentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}
Update Agent
BetaManagedAgentsAgent beta().agents().update(params = AgentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}
Archive Agent
BetaManagedAgentsAgent beta().agents().archive(params = AgentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
VersionListPage beta().agents().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
BetaEnvironment beta().environments().create(params, requestOptions = RequestOptions.none())
POST/v1/environments

Create a new environment with the specified configuration.

List Environments
EnvironmentListPage beta().environments().list(params = EnvironmentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments

List environments with pagination support.

Get Environment
BetaEnvironment beta().environments().retrieve(params = EnvironmentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}

Retrieve a specific environment by ID.

Update Environment
BetaEnvironment beta().environments().update(params = EnvironmentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}

Update an existing environment's configuration.

Delete Environment
BetaEnvironmentDeleteResponse beta().environments().delete(params = EnvironmentDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/environments/{environment_id}

Delete an environment by ID. Returns a confirmation of the deletion.

Archive Environment
BetaEnvironment beta().environments().archive(params = EnvironmentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/archive

Archive an environment by ID. Archived environments cannot be used to create new sessions.

BetaEnvironmentsWork

Get Work Item
BetaSelfHostedWork beta().environments().work().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/{work_id}

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Poll for Work
BetaSelfHostedWork beta().environments().work().poll(params = WorkPollParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/poll

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Acknowledge Work
BetaSelfHostedWork beta().environments().work().ack(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/ack

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Record Heartbeat
BetaSelfHostedWorkHeartbeatResponse beta().environments().work().heartbeat(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Stop Work
BetaSelfHostedWork beta().environments().work().stop(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/stop

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

List Work Items
WorkListPage beta().environments().work().list(params = WorkListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Update Work Item
BetaSelfHostedWork beta().environments().work().update(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}

Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.

Get Queue Statistics
BetaSelfHostedWorkQueueStats beta().environments().work().stats(params = WorkStatsParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/stats

Get statistics about the work queue for an environment.

BetaSessions

Create Session
BetaManagedAgentsSession beta().sessions().create(params, requestOptions = RequestOptions.none())
POST/v1/sessions
List Sessions
SessionListPage beta().sessions().list(params = SessionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions
Get Session
BetaManagedAgentsSession beta().sessions().retrieve(params = SessionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}
Update Session
BetaManagedAgentsSession beta().sessions().update(params = SessionUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}
Delete Session
BetaManagedAgentsDeletedSession beta().sessions().delete(params = SessionDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}
Archive Session
BetaManagedAgentsSession beta().sessions().archive(params = SessionArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
EventListPage beta().sessions().events().list(params = EventListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events
Send Events
BetaManagedAgentsSendSessionEvents beta().sessions().events().send(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/events
Stream Events
StreamResponse<BetaManagedAgentsStreamSessionEvents> beta().sessions().events().streamStreaming(params = EventStreamParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
BetaManagedAgentsFileResource beta().sessions().resources().add(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources
List Session Resources
ResourceListPage beta().sessions().resources().list(params = ResourceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources
Get Session Resource
ResourceRetrieveResponse beta().sessions().resources().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
ResourceUpdateResponse beta().sessions().resources().update(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
BetaManagedAgentsDeleteSessionResource beta().sessions().resources().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
ThreadListPage beta().sessions().threads().list(params = ThreadListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads
Get Session Thread
BetaManagedAgentsSessionThread beta().sessions().threads().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
BetaManagedAgentsSessionThread beta().sessions().threads().archive(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
EventListPage beta().sessions().threads().events().list(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
StreamResponse<BetaManagedAgentsStreamSessionThreadEvents> beta().sessions().threads().events().streamStreaming(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
BetaManagedAgentsDeployment beta().deployments().create(params, requestOptions = RequestOptions.none())
POST/v1/deployments
List Deployments
DeploymentListPage beta().deployments().list(params = DeploymentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployments
Get Deployment
BetaManagedAgentsDeployment beta().deployments().retrieve(params = DeploymentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployments/{deployment_id}
Update Deployment
BetaManagedAgentsDeployment beta().deployments().update(params = DeploymentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}
Archive Deployment
BetaManagedAgentsDeployment beta().deployments().archive(params = DeploymentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
BetaManagedAgentsDeploymentRun beta().deployments().run(params = DeploymentRunParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/run
Pause Deployment
BetaManagedAgentsDeployment beta().deployments().pause(params = DeploymentPauseParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
BetaManagedAgentsDeployment beta().deployments().unpause(params = DeploymentUnpauseParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
DeploymentRunListPage beta().deploymentRuns().list(params = DeploymentRunListParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployment_runs
Get Deployment Run
BetaManagedAgentsDeploymentRun beta().deploymentRuns().retrieve(params = DeploymentRunRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
BetaManagedAgentsVault beta().vaults().create(params, requestOptions = RequestOptions.none())
POST/v1/vaults
List Vaults
VaultListPage beta().vaults().list(params = VaultListParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults
Get Vault
BetaManagedAgentsVault beta().vaults().retrieve(params = VaultRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}
Update Vault
BetaManagedAgentsVault beta().vaults().update(params = VaultUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}
Delete Vault
BetaManagedAgentsDeletedVault beta().vaults().delete(params = VaultDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}
Archive Vault
BetaManagedAgentsVault beta().vaults().archive(params = VaultArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
BetaManagedAgentsCredential beta().vaults().credentials().create(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials
List Credentials
CredentialListPage beta().vaults().credentials().list(params = CredentialListParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials
Get Credential
BetaManagedAgentsCredential beta().vaults().credentials().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
BetaManagedAgentsCredential beta().vaults().credentials().update(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
BetaManagedAgentsDeletedCredential beta().vaults().credentials().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
BetaManagedAgentsCredential beta().vaults().credentials().archive(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
BetaManagedAgentsCredentialValidation beta().vaults().credentials().mcpOAuthValidate(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().create(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores
List memory stores
MemoryStoreListPage beta().memoryStores().list(params = MemoryStoreListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores
Retrieve a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().retrieve(params = MemoryStoreRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}
Update a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().update(params = MemoryStoreUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
BetaManagedAgentsDeletedMemoryStore beta().memoryStores().delete(params = MemoryStoreDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
BetaManagedAgentsMemoryStore beta().memoryStores().archive(params = MemoryStoreArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
BetaManagedAgentsMemory beta().memoryStores().memories().create(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories
List memories
MemoryListPage beta().memoryStores().memories().list(params = MemoryListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
BetaManagedAgentsMemory beta().memoryStores().memories().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
BetaManagedAgentsMemory beta().memoryStores().memories().update(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
BetaManagedAgentsDeletedMemory beta().memoryStores().memories().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
MemoryVersionListPage beta().memoryStores().memoryVersions().list(params = MemoryVersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().redact(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
BetaFileMetadata beta().files().upload(params, requestOptions = RequestOptions.none())
POST/v1/files
List Files
FileListPage beta().files().list(params = FileListParams.none(), requestOptions = RequestOptions.none())
GET/v1/files
Download File
HttpResponse beta().files().download(params = FileDownloadParams.none(), requestOptions = RequestOptions.none())
GET/v1/files/{file_id}/content
Get File Metadata
BetaFileMetadata beta().files().retrieveMetadata(params = FileRetrieveMetadataParams.none(), requestOptions = RequestOptions.none())
GET/v1/files/{file_id}
Delete File
BetaDeletedFile beta().files().delete(params = FileDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
BetaSkill beta().skills().create(params, requestOptions = RequestOptions.none())
POST/v1/skills
List Skills
SkillListPage beta().skills().list(params = SkillListParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills
Get Skill
BetaSkill beta().skills().retrieve(params = SkillRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}
Delete Skill
BetaDeletedSkill beta().skills().delete(params = SkillDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
BetaSkillVersion beta().skills().versions().create(params, requestOptions = RequestOptions.none())
POST/v1/skills/{skill_id}/versions
List Skill Versions
VersionListPage beta().skills().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
HttpResponse beta().skills().versions().download(params, requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}/content

Download a skill version's content as a zip archive.

Get Skill Version
BetaSkillVersion beta().skills().versions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
BetaDeletedSkillVersion beta().skills().versions().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}/versions/{version}

BetaUser Profiles

Create User Profile
BetaUserProfile beta().userProfiles().create(params = UserProfileCreateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles
List User Profiles
UserProfileListPage beta().userProfiles().list(params = UserProfileListParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles
Get User Profile
BetaUserProfile beta().userProfiles().retrieve(params = UserProfileRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles/{user_profile_id}
Update User Profile
BetaUserProfile beta().userProfiles().update(params = UserProfileUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
BetaUserProfileEnrollmentUrl beta().userProfiles().createEnrollmentUrl(params = UserProfileCreateEnrollmentUrlParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
BetaDream beta().dreams().create(params, requestOptions = RequestOptions.none())
POST/v1/dreams

Start an asynchronous job that uses past sessions to produce a reorganized version of a memory store and get back the dream to poll for the result.

List Dreams
DreamListPage beta().dreams().list(params = DreamListParams.none(), requestOptions = RequestOptions.none())
GET/v1/dreams

List the dreams in the workspace, newest first.

Get a Dream
BetaDream beta().dreams().retrieve(params = DreamRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/dreams/{dream_id}

Get a dream by ID to check its status, output memory store, and token usage.

Cancel a Dream
BetaDream beta().dreams().cancel(params = DreamCancelParams.none(), requestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/cancel

Stop a pending or running dream.

Archive a Dream
BetaDream beta().dreams().archive(params = DreamArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/archive

Hide a completed, failed, or canceled dream from the default list of dreams.

BetaTunnels

Create Tunnel
BetaTunnel beta().tunnels().create(params = TunnelCreateParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Get Tunnel
BetaTunnel beta().tunnels().retrieve(params = TunnelRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

List Tunnels
TunnelListPage beta().tunnels().list(params = TunnelListParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Archive Tunnel
BetaTunnel beta().tunnels().archive(params = TunnelArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/archive

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Reveal Tunnel Token
BetaTunnelToken beta().tunnels().revealToken(params = TunnelRevealTokenParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/reveal_token

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Rotate Tunnel Token
BetaTunnelToken beta().tunnels().rotateToken(params = TunnelRotateTokenParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/rotate_token

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

BetaTunnelsCertificates

Create Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().create(params, requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Get Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

List Tunnel Certificates
CertificateListPage beta().tunnels().certificates().list(params = CertificateListParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

Archive Tunnel Certificate
BetaTunnelCertificate beta().tunnels().certificates().archive(params, requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

The Tunnels API is in research preview. It requires the anthropic-beta: mcp-tunnels-2026-06-22 header and may change without a deprecation period. It supersedes the Admin API endpoints at /v1/organizations/tunnels, which remain available during a migration window.

BetaOrganization

Get Current Organization
BetaOrganization beta().organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/me

Retrieve information about the organization associated with the authenticated API key.

BetaOrganizationAPI Keys

List API Keys
ApiKeyListPage beta().organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
BetaApiKey beta().organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}

Retrieve information about a single API key in your organization, looked up by its ID. This Admin API endpoint requires an Admin API key, is intended for programmatic key management, and never returns the key's secret value. To view or create your own API keys, go to API keys in the Claude Console.

Update API Key
BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
BetaExternalKey beta().organization().externalKeys().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys

Create an external key config owned by the caller's organization.

List External Keys
ExternalKeyListPage beta().organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
BetaExternalKey beta().organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}

Retrieve a single external key config in the caller's organization by ID.

Update External Key
BetaExternalKey beta().organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}

Partially update an external key config. Omitted fields are left unchanged.

Delete External Key
ExternalKeyDeleteResponse beta().organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
ExternalKeyValidateResponse beta().organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

BetaOrganizationFederationIssuers

Create Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Issuers
IssuerListPage beta().organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationFederationRules

Create Federation Rule
BetaFederationRule beta().organization().federation().rules().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rules
RuleListPage beta().organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Rule
BetaFederationRule beta().organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Rule
BetaFederationRule beta().organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Rule
BetaFederationRule beta().organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rule Workspaces
WorkspaceListPage beta().organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Federation Rule Workspace
WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationInvites

Create Invite
BetaOrganizationInvite beta().organization().invites().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
InviteListPage beta().organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites

List the organization's invites.

Get Invite
BetaOrganizationInvite beta().organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
InviteDeleteResponse beta().organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

BetaOrganizationService Accounts

Create Service Account
BetaServiceAccount beta().organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Service Accounts
ServiceAccountListPage beta().organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account
BetaServiceAccount beta().organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account
BetaServiceAccount beta().organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Service Account
BetaServiceAccount beta().organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Workspaces For Service Account
WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Workspace From Service Account
WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationUsers

List Users
UserListPage beta().organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users

List the organization's members.

Get User
BetaOrganizationUser beta().organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
BetaOrganizationUser beta().organization().users().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
UserRemoveResponse beta().organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

BetaOrganizationWorkspaces

List Workspaces
WorkspaceListPage beta().organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace beta().organization().workspaces().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace beta().organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace beta().organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace beta().organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage beta().organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

BetaOrganizationWorkspacesMembers

List Workspace Members
MemberListPage beta().organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse beta().organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Create Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Delete Service Account Workspace Member
ServiceAccountRemoveResponse beta().organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

BetaOrganizationRate Limits

List Organization Rate Limits
RateLimitListPage beta().organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BetaOrganizationCompliance Settings

Get Compliance Settings
BetaComplianceSettings beta().organization().complianceSettings().retrieve(params = ComplianceSettingRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
BetaComplianceSettings beta().organization().complianceSettings().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.

BetaOrganizationAnalyticsSummaries

Get Activity Summaries
SummaryListPage beta().organization().analytics().summaries().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BetaOrganizationAnalyticsUsers

List User Activity
UserListPage beta().organization().analytics().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/users

Get per-user activity for a given day, with cursor-based pagination.

BetaOrganizationAnalyticsAppsChatProjects

Get Chat Project Usage
ProjectListPage beta().organization().analytics().apps().chat().projects().list(params = ProjectListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/apps/chat/projects

Get per-project activity for a given day, with cursor-based pagination.

BetaOrganizationAnalyticsConnectors

Get Connector Usage
ConnectorListPage beta().organization().analytics().connectors().list(params = ConnectorListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/connectors

Get per-connector usage for a given day, with cursor-based pagination.

BetaOrganizationAnalyticsPlugins

Get Plugin Usage
PluginListPage beta().organization().analytics().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/plugins

Get per-plugin install + invocation usage for a given day, with pagination.

BetaOrganizationAnalyticsSkills

Get Skill Usage
SkillListPage beta().organization().analytics().skills().list(params = SkillListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/skills

Get per-skill usage for a given day, with cursor-based pagination.

BetaOrganizationAnalyticsArtifacts

Get Artifact Activity
ArtifactListPage beta().organization().analytics().artifacts().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/artifacts

Get artifact-creation activity for a given day, broken out by MIME type.

BetaOrganizationAnalyticsUsage Report

Get Token Usage Over Time
UsageReportListPage beta().organization().analytics().usageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/usage_report

Get token usage over time across a date range.

BetaOrganizationAnalyticsUser Usage Report

Get Per-User Token Usage
UserUsageReportListPage beta().organization().analytics().userUsageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_usage_report

Get per-user token usage across a date range.

BetaOrganizationAnalyticsCost Report

Get Cost Over Time
CostReportListPage beta().organization().analytics().costReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/cost_report

Get cost in USD over time across a date range.

BetaOrganizationAnalyticsUser Cost Report

Get Per-User Cost
UserCostReportListPage beta().organization().analytics().userCostReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_cost_report

Get per-user cost in USD across a date range.

BetaOrganizationSpend Limits

Set Spend Limit
BetaSpendLimit beta().organization().spendLimits().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limits

Set a spend limit.

Get Spend Limit
BetaSpendLimit beta().organization().spendLimits().retrieve(params = SpendLimitRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/{spend_limit_id}

Retrieve a spend limit by ID.

Delete Spend Limit
SpendLimitDeleteResponse beta().organization().spendLimits().delete(params = SpendLimitDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Delete a spend limit.

List Spend Limits
SpendLimitListPage beta().organization().spendLimits().list(params = SpendLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits

List the organization's spend limits.

BetaOrganizationSpend LimitsEffective

List Effective Spend Limits
EffectiveListPage beta().organization().spendLimits().effective().list(params = EffectiveListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/effective

List each member's effective spend limit and period-to-date spend.

BetaOrganizationSpend LimitsIncrease Requests

List Spend Limit Increase Requests
IncreaseRequestListPage beta().organization().spendLimits().increaseRequests().list(params = IncreaseRequestListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Get Spend Limit Increase Request
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().retrieve(params = IncreaseRequestRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

Approve Spend Limit Increase Request
IncreaseRequestApproveResponse beta().organization().spendLimits().increaseRequests().approve(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Approve a pending spend limit increase request.

Deny Spend Limit Increase Request
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().deny(params = IncreaseRequestDenyParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deny a pending spend limit increase request.

BetaOrganizationRBAC Groups

Create RBAC Group
BetaRbacGroup beta().organization().rbacGroups().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups

Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type "direct".

List RBAC Groups
RbacGroupListPage beta().organization().rbacGroups().list(params = RbacGroupListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

Get RBAC Group
BetaRbacGroup beta().organization().rbacGroups().retrieve(params = RbacGroupRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}

Retrieve an RBAC Group by ID.

Update RBAC Group
BetaRbacGroup beta().organization().rbacGroups().update(params = RbacGroupUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}

Update an RBAC Group's name. Groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

Delete RBAC Group
RbacGroupDeleteResponse beta().organization().rbacGroups().delete(params = RbacGroupDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Delete an RBAC Group. Groups provisioned by an identity provider (source type "scim") cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.

BetaOrganizationRBAC GroupsMembers

List RBAC Group Members
MemberListPage beta().organization().rbacGroups().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

List members of an RBAC Group.

Add RBAC Group Member
BetaRbacGroupMember beta().organization().rbacGroups().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

Remove RBAC Group Member
MemberRemoveResponse beta().organization().rbacGroups().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

BetaOrganizationRBAC Roles

List RBAC Roles
RbacRoleListPage beta().organization().rbacRoles().list(params = RbacRoleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles

List RBAC Roles in the organization.

Get RBAC Role
BetaRbacRole beta().organization().rbacRoles().retrieve(params = RbacRoleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}

Retrieve an RBAC Role by ID.

BetaOrganizationRBAC RolesPermissions

List RBAC Role Permissions
PermissionListPage beta().organization().rbacRoles().permissions().list(params = PermissionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

List the permissions an RBAC Role grants.

BetaOrganizationPlugins

Create Plugin
BetaPlugin beta().organization().plugins().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
BetaPlugin beta().organization().plugins().retrieve(params = PluginRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
BetaPlugin beta().organization().plugins().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
PluginListPage beta().organization().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
BetaDeletedPlugin beta().organization().plugins().delete(params = PluginDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

BetaOrganizationPluginsVersions

Create Plugin Version
BetaPluginVersion beta().organization().plugins().versions().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
VersionListPage beta().organization().plugins().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
BetaPluginVersion beta().organization().plugins().versions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
HttpResponse beta().organization().plugins().versions().download(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

BetaOrganizationPluginsInstallation Settings

List Plugin Installation Settings
InstallationSettingListPage beta().organization().plugins().installationSettings().list(params = InstallationSettingListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
BetaPluginInstallationSetting beta().organization().plugins().installationSettings().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
BetaDeletedPluginInstallationSetting beta().organization().plugins().installationSettings().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

BetaOrganizationPluginsShares

List Plugin Shares
ShareListPage beta().organization().plugins().shares().list(params = ShareListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

BetaOrganizationPlugin Marketplaces

List Plugin Marketplaces
PluginMarketplaceListPage beta().organization().pluginMarketplaces().list(params = PluginMarketplaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
BetaPluginMarketplace beta().organization().pluginMarketplaces().retrieve(params = PluginMarketplaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
BetaPluginMarketplace beta().organization().pluginMarketplaces().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateRepository(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateArchive(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.

BetaOrganizationTelemetry Destinations

Create a Telemetry Destination
BetaTelemetryDestination beta().organization().telemetryDestinations().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations

Register an OpenTelemetry destination for the organization.

List Telemetry Destinations
TelemetryDestinationListPage beta().organization().telemetryDestinations().list(params = TelemetryDestinationListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations

List the organization's destinations, newest first, optionally only those that cover given workspaces.

Retrieve a Telemetry Destination
BetaTelemetryDestination beta().organization().telemetryDestinations().retrieve(params = TelemetryDestinationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}

Read a destination's configuration, state, and most recent delivery results.

Update a Telemetry Destination
BetaTelemetryDestination beta().organization().telemetryDestinations().update(params = TelemetryDestinationUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}

Change a telemetry destination's settings, its state, or which workspaces it covers.

Delete a Telemetry Destination
BetaDeletedTelemetryDestination beta().organization().telemetryDestinations().delete(params = TelemetryDestinationDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}

Delete a destination and its workspace list.

Test a Telemetry Destination
BetaTelemetryDestinationTestResponse beta().organization().telemetryDestinations().test(params = TelemetryDestinationTestParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/test

Send one test span, named anthropic.test, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its result has the type success, or the type failure and the reason in error. The destination's configuration, state and delivery_health do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429.

BetaOrganizationTelemetry DestinationsWorkspaces

List Telemetry Destination Workspaces
WorkspaceListPage beta().organization().telemetryDestinations().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

List the workspaces on a destination's workspace list, newest entry first.

Add a Telemetry Destination Workspace
BetaTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Add one workspace to a destination's workspace list.

Remove a Telemetry Destination Workspace
BetaDeletedTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Remove one workspace from a destination's workspace list.