Claude Platform Docs

Beta

Models
class BetaApiError { Type = "api_error"; Message; }
JsonElement Type = "api_error"
required string Message
class BetaAuthenticationError { Type = "authentication_error"; Message; }
JsonElement Type = "authentication_error"
required string Message
class BetaBillingError { Type = "billing_error"; Message; }
JsonElement Type = "billing_error"
required string Message
enum BetaCurrency
Usd("USD")
class BetaError: union
class BetaErrorResponse { Type = "error"; Error; RequestID; }
JsonElement Type = "error"
required BetaError Error
One of the following:
required string? RequestID
class BetaGatewayTimeoutError { Type = "timeout_error"; Message; }
JsonElement Type = "timeout_error"
required string Message
class BetaInvalidRequestError { Type = "invalid_request_error"; Message; }
JsonElement Type = "invalid_request_error"
required string Message
class BetaMonetaryAmount { Amount; Currency; }

A monetary amount in a specific currency.

required 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.

required 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; }
JsonElement Type = "not_found_error"
required string Message
class BetaOverloadedError { Type = "overloaded_error"; Message; }
JsonElement Type = "overloaded_error"
required string Message
class BetaPermissionError { Type = "permission_error"; Message; }
JsonElement Type = "permission_error"
required string Message
class BetaRateLimitError { Type = "rate_limit_error"; Message; }
JsonElement Type = "rate_limit_error"
required string Message

BetaModels

List Models
ModelListPage Beta.Models.List(parameters, cancellationToken = default)
GET/v1/models

List available models.

Get a Model
BetaModelInfo Beta.Models.Retrieve(parameters, cancellationToken = default)
GET/v1/models/{model_id}

Get a specific model.

BetaMessages

Create a Message
BetaMessage Beta.Messages.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/messages/count_tokens

Count the number of tokens in a Message.

BetaMessagesBatches

Create a Message Batch
BetaMessageBatch Beta.Messages.Batches.Create(parameters, cancellationToken = default)
POST/v1/messages/batches

Send a batch of Message creation requests.

Retrieve a Message Batch
BetaMessageBatch Beta.Messages.Batches.Retrieve(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
BetaMessageBatchIndividualResponse Beta.Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/agents
List Agents
AgentListPage Beta.Agents.List(parameters, cancellationToken = default)
GET/v1/agents
Get Agent
BetaManagedAgentsAgent Beta.Agents.Retrieve(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}
Update Agent
BetaManagedAgentsAgent Beta.Agents.Update(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}
Archive Agent
BetaManagedAgentsAgent Beta.Agents.Archive(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
VersionListPage Beta.Agents.Versions.List(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
BetaEnvironment Beta.Environments.Create(parameters, cancellationToken = default)
POST/v1/environments

Create a new environment with the specified configuration.

List Environments
EnvironmentListPage Beta.Environments.List(parameters, cancellationToken = default)
GET/v1/environments

List environments with pagination support.

Get Environment
BetaEnvironment Beta.Environments.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}

Retrieve a specific environment by ID.

Update Environment
BetaEnvironment Beta.Environments.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}

Update an existing environment's configuration.

Delete Environment
BetaEnvironmentDeleteResponse Beta.Environments.Delete(parameters, cancellationToken = default)
DELETE/v1/environments/{environment_id}

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

Archive Environment
BetaEnvironment Beta.Environments.Archive(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/stats

Get statistics about the work queue for an environment.

BetaSessions

Create Session
BetaManagedAgentsSession Beta.Sessions.Create(parameters, cancellationToken = default)
POST/v1/sessions
List Sessions
SessionListPage Beta.Sessions.List(parameters, cancellationToken = default)
GET/v1/sessions
Get Session
BetaManagedAgentsSession Beta.Sessions.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}
Update Session
BetaManagedAgentsSession Beta.Sessions.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}
Delete Session
BetaManagedAgentsDeletedSession Beta.Sessions.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}
Archive Session
BetaManagedAgentsSession Beta.Sessions.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
EventListPage Beta.Sessions.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events
Send Events
BetaManagedAgentsSendSessionEvents Beta.Sessions.Events.Send(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/events
Stream Events
BetaManagedAgentsStreamSessionEvents Beta.Sessions.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
BetaManagedAgentsFileResource Beta.Sessions.Resources.Add(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources
List Session Resources
ResourceListPage Beta.Sessions.Resources.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources
Get Session Resource
ResourceRetrieveResponse Beta.Sessions.Resources.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
ResourceUpdateResponse Beta.Sessions.Resources.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
BetaManagedAgentsDeleteSessionResource Beta.Sessions.Resources.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
ThreadListPage Beta.Sessions.Threads.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads
Get Session Thread
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
EventListPage Beta.Sessions.Threads.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
BetaManagedAgentsStreamSessionThreadEvents Beta.Sessions.Threads.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
BetaManagedAgentsDeployment Beta.Deployments.Create(parameters, cancellationToken = default)
POST/v1/deployments
List Deployments
DeploymentListPage Beta.Deployments.List(parameters, cancellationToken = default)
GET/v1/deployments
Get Deployment
BetaManagedAgentsDeployment Beta.Deployments.Retrieve(parameters, cancellationToken = default)
GET/v1/deployments/{deployment_id}
Update Deployment
BetaManagedAgentsDeployment Beta.Deployments.Update(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}
Archive Deployment
BetaManagedAgentsDeployment Beta.Deployments.Archive(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
BetaManagedAgentsDeploymentRun Beta.Deployments.Run(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/run
Pause Deployment
BetaManagedAgentsDeployment Beta.Deployments.Pause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
BetaManagedAgentsDeployment Beta.Deployments.Unpause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
DeploymentRunListPage Beta.DeploymentRuns.List(parameters, cancellationToken = default)
GET/v1/deployment_runs
Get Deployment Run
BetaManagedAgentsDeploymentRun Beta.DeploymentRuns.Retrieve(parameters, cancellationToken = default)
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
BetaManagedAgentsVault Beta.Vaults.Create(parameters, cancellationToken = default)
POST/v1/vaults
List Vaults
VaultListPage Beta.Vaults.List(parameters, cancellationToken = default)
GET/v1/vaults
Get Vault
BetaManagedAgentsVault Beta.Vaults.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}
Update Vault
BetaManagedAgentsVault Beta.Vaults.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}
Delete Vault
BetaManagedAgentsDeletedVault Beta.Vaults.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}
Archive Vault
BetaManagedAgentsVault Beta.Vaults.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Create(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials
List Credentials
CredentialListPage Beta.Vaults.Credentials.List(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials
Get Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
BetaManagedAgentsDeletedCredential Beta.Vaults.Credentials.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
BetaManagedAgentsCredential Beta.Vaults.Credentials.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
BetaManagedAgentsCredentialValidation Beta.Vaults.Credentials.McpOAuthValidate(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
BetaManagedAgentsMemoryStore Beta.MemoryStores.Create(parameters, cancellationToken = default)
POST/v1/memory_stores
List memory stores
MemoryStoreListPage Beta.MemoryStores.List(parameters, cancellationToken = default)
GET/v1/memory_stores
Retrieve a memory store
BetaManagedAgentsMemoryStore Beta.MemoryStores.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}
Update a memory store
BetaManagedAgentsMemoryStore Beta.MemoryStores.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
BetaManagedAgentsDeletedMemoryStore Beta.MemoryStores.Delete(parameters, cancellationToken = default)
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
BetaManagedAgentsMemoryStore Beta.MemoryStores.Archive(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Create(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories
List memories
MemoryListPage Beta.MemoryStores.Memories.List(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
BetaManagedAgentsDeletedMemory Beta.MemoryStores.Memories.Delete(parameters, cancellationToken = default)
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
MemoryVersionListPage Beta.MemoryStores.MemoryVersions.List(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Redact(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
BetaFileMetadata Beta.Files.Upload(parameters, cancellationToken = default)
POST/v1/files
List Files
FileListPage Beta.Files.List(parameters, cancellationToken = default)
GET/v1/files
Download File
HttpResponse Beta.Files.Download(parameters, cancellationToken = default)
GET/v1/files/{file_id}/content
Get File Metadata
BetaFileMetadata Beta.Files.RetrieveMetadata(parameters, cancellationToken = default)
GET/v1/files/{file_id}
Delete File
BetaDeletedFile Beta.Files.Delete(parameters, cancellationToken = default)
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
BetaSkill Beta.Skills.Create(parameters, cancellationToken = default)
POST/v1/skills
List Skills
SkillListPage Beta.Skills.List(parameters, cancellationToken = default)
GET/v1/skills
Get Skill
BetaSkill Beta.Skills.Retrieve(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}
Delete Skill
BetaDeletedSkill Beta.Skills.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
BetaSkillVersion Beta.Skills.Versions.Create(parameters, cancellationToken = default)
POST/v1/skills/{skill_id}/versions
List Skill Versions
VersionListPage Beta.Skills.Versions.List(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
HttpResponse Beta.Skills.Versions.Download(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
BetaDeletedSkillVersion Beta.Skills.Versions.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}/versions/{version}

BetaUser Profiles

Create User Profile
BetaUserProfile Beta.UserProfiles.Create(parameters, cancellationToken = default)
POST/v1/user_profiles
List User Profiles
UserProfileListPage Beta.UserProfiles.List(parameters, cancellationToken = default)
GET/v1/user_profiles
Get User Profile
BetaUserProfile Beta.UserProfiles.Retrieve(parameters, cancellationToken = default)
GET/v1/user_profiles/{user_profile_id}
Update User Profile
BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
BetaUserProfileEnrollmentUrl Beta.UserProfiles.CreateEnrollmentUrl(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
BetaDream Beta.Dreams.Create(parameters, cancellationToken = default)
POST/v1/dreams
List Dreams
DreamListPage Beta.Dreams.List(parameters, cancellationToken = default)
GET/v1/dreams
Get a Dream
BetaDream Beta.Dreams.Retrieve(parameters, cancellationToken = default)
GET/v1/dreams/{dream_id}
Cancel a Dream
BetaDream Beta.Dreams.Cancel(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
BetaDream Beta.Dreams.Archive(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
BetaTunnel Beta.Tunnels.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

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

List External Keys
ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

List the organization's invites.

Get Invite
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

BetaOrganizationService Accounts

Create Service Account
BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/organizations/users

List the organization's members.

Get User
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

BetaOrganizationWorkspaces

List Workspaces
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List rate-limit overrides configured for a workspace.

BetaOrganizationWorkspacesMembers

List Workspace Members
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BetaOrganizationCompliance Settings

Get Compliance Settings
BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
BetaComplianceSettings Beta.Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.