Claude Platform Docs

Beta

Models
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more
One of the following:
BetaAPIError object{ type: "api_error", message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
BetaAuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
BetaBillingError object{ type: "billing_error", message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more
One of the following:
BetaErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string or null
BetaGatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
BetaInvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
BetaMonetaryAmount object{ amount, currency }

A monetary amount in a specific currency.

amount: string

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

currency: BetaCurrency

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

BetaNotFoundError object{ type: "not_found_error", message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
BetaOverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
BetaPermissionError object{ type: "permission_error", message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
BetaRateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

BetaModels

List Models
GET/v1/models

List available models.

Get a Model
GET/v1/models/{model_id}

Get a specific model.

BetaMessages

Create a Message
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
POST/v1/messages/count_tokens

Count the number of tokens in a Message.

BetaMessagesBatches

Create a Message Batch
POST/v1/messages/batches

Send a batch of Message creation requests.

Retrieve a Message Batch
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
GET/v1/messages/batches

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

Cancel a Message Batch
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
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
GET/v1/messages/batches/{message_batch_id}/results

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

BetaAgents

Create Agent
POST/v1/agents
List Agents
GET/v1/agents
Get Agent
GET/v1/agents/{agent_id}
Update Agent
POST/v1/agents/{agent_id}
Archive Agent
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
POST/v1/environments

Create a new environment with the specified configuration.

List Environments
GET/v1/environments

List environments with pagination support.

Get Environment
GET/v1/environments/{environment_id}

Retrieve a specific environment by ID.

Update Environment
POST/v1/environments/{environment_id}

Update an existing environment's configuration.

Delete Environment
DELETE/v1/environments/{environment_id}

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

Archive Environment
POST/v1/environments/{environment_id}/archive

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

BetaEnvironmentsWork

Get Work Item
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
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
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
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
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
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
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
GET/v1/environments/{environment_id}/work/stats

Get statistics about the work queue for an environment.

BetaSessions

Create Session
POST/v1/sessions
List Sessions
GET/v1/sessions
Get Session
GET/v1/sessions/{session_id}
Update Session
POST/v1/sessions/{session_id}
Delete Session
DELETE/v1/sessions/{session_id}
Archive Session
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
GET/v1/sessions/{session_id}/events
Send Events
POST/v1/sessions/{session_id}/events
Stream Events
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
POST/v1/sessions/{session_id}/resources
List Session Resources
GET/v1/sessions/{session_id}/resources
Get Session Resource
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
GET/v1/sessions/{session_id}/threads
Get Session Thread
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
POST/v1/deployments
List Deployments
GET/v1/deployments
Get Deployment
GET/v1/deployments/{deployment_id}
Update Deployment
POST/v1/deployments/{deployment_id}
Archive Deployment
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
POST/v1/deployments/{deployment_id}/run
Pause Deployment
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
GET/v1/deployment_runs
Get Deployment Run
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
POST/v1/vaults
List Vaults
GET/v1/vaults
Get Vault
GET/v1/vaults/{vault_id}
Update Vault
POST/v1/vaults/{vault_id}
Delete Vault
DELETE/v1/vaults/{vault_id}
Archive Vault
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
POST/v1/vaults/{vault_id}/credentials
List Credentials
GET/v1/vaults/{vault_id}/credentials
Get Credential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
POST/v1/memory_stores
List memory stores
GET/v1/memory_stores
Retrieve a memory store
GET/v1/memory_stores/{memory_store_id}
Update a memory store
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
POST/v1/memory_stores/{memory_store_id}/memories
List memories
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
POST/v1/files
List Files
GET/v1/files
Download File
GET/v1/files/{file_id}/content
Get File Metadata
GET/v1/files/{file_id}
Delete File
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
POST/v1/skills
List Skills
GET/v1/skills
Get Skill
GET/v1/skills/{skill_id}
Delete Skill
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
POST/v1/skills/{skill_id}/versions
List Skill Versions
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
GET/v1/skills/{skill_id}/versions/{version}/content

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

Get Skill Version
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
DELETE/v1/skills/{skill_id}/versions/{version}

BetaUser Profiles

Create User Profile
POST/v1/user_profiles
List User Profiles
GET/v1/user_profiles
Get User Profile
GET/v1/user_profiles/{user_profile_id}
Update User Profile
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
POST/v1/dreams
List Dreams
GET/v1/dreams
Get a Dream
GET/v1/dreams/{dream_id}
Cancel a Dream
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
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
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
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
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
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
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
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
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
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
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
GET/v1/organizations/me

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

BetaOrganizationAPI Keys

List API Keys
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
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
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
POST/v1/organizations/external_keys

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

List External Keys
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
GET/v1/organizations/external_keys/{external_key_id}

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

Update External Key
POST/v1/organizations/external_keys/{external_key_id}

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

Delete External Key
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
POST/v1/organizations/external_keys/{external_key_id}/validate

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

BetaOrganizationFederationIssuers

Create Federation Issuer
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
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
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
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
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
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
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
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
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
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
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
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
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
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
GET/v1/organizations/invites

List the organization's invites.

Get Invite
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

BetaOrganizationService Accounts

Create Service Account
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
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
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
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
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
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
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
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
GET/v1/organizations/users

List the organization's members.

Get User
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

BetaOrganizationWorkspaces

List Workspaces
GET/v1/organizations/workspaces
Create Workspace
POST/v1/organizations/workspaces
Get Workspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List rate-limit overrides configured for a workspace.

BetaOrganizationWorkspacesMembers

List Workspace Members
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
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
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
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
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
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
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BetaOrganizationCompliance Settings

Get Compliance Settings
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.

BetaOrganizationUsage Report

Get Messages Usage Report
GET/v1/organizations/usage_report/messages
Get Claude Code Usage Report
GET/v1/organizations/usage_report/claude_code

Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.

BetaOrganizationCost Report

Get Cost Report
GET/v1/organizations/cost_report

BetaOrganizationMCP Tunnels

List Tunnels
Deprecated
GET/v1/organizations/tunnels

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Get Tunnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Archive Tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Reveal Tunnel Token
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Rotate Tunnel Token
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

BetaOrganizationMCP TunnelsTunnel Certificates

Create Tunnel Certificate
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

List Tunnel Certificates
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Get Tunnel Certificate
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

Archive Tunnel Certificate
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Deprecated. This Admin API endpoint is superseded by /v1/tunnels on the Claude API and will be removed after a migration window. New integrations should use /v1/tunnels with the anthropic-beta: mcp-tunnels-2026-06-22 header and a WIF token carrying the workspace:manage_tunnels scope. Existing integrations continue to work with the mcp-tunnels-2026-05-19 header and org:manage_tunnels scope during the migration window.

BetaOrganizationAnalytics

Get Activity Summaries
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BetaOrganizationAnalyticsUsage

Get Token Usage Over Time
GET/v1/organizations/analytics/usage_report

Get token usage over time across a date range.

Get Per-User Token Usage
GET/v1/organizations/analytics/user_usage_report

Get per-user token usage across a date range.

BetaOrganizationAnalyticsCost

Get Cost Over Time
GET/v1/organizations/analytics/cost_report

Get cost in USD over time across a date range.

Get Per-User Cost
GET/v1/organizations/analytics/user_cost_report

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

BetaOrganizationAnalyticsUsers

List User Activity
GET/v1/organizations/analytics/users

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

BetaOrganizationAnalyticsSkills

Get Skill Usage
GET/v1/organizations/analytics/skills

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

BetaOrganizationAnalyticsConnectors

Get Connector Usage
GET/v1/organizations/analytics/connectors

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

BetaOrganizationAnalyticsChat Projects

Get Chat Project Usage
GET/v1/organizations/analytics/apps/chat/projects

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

BetaOrganizationAnalyticsPlugins

Get Plugin Usage
GET/v1/organizations/analytics/plugins

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

BetaOrganizationAnalyticsArtifacts

Get Artifact Activity
GET/v1/organizations/analytics/artifacts

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

BetaOrganizationSpend Limits

Set Spend Limit
POST/v1/organizations/spend_limits

Set a per-user spend limit override.

Get Spend Limit
GET/v1/organizations/spend_limits/{spend_limit_id}

Retrieve a spend limit by ID.

Delete Spend Limit
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Delete a per-user spend limit override.

List Effective Spend Limits
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
GET/v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Get Spend Limit Increase Request
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

Approve Spend Limit Increase Request
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
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deny a pending spend limit increase request.

BetaOrganizationRBAC Groups

List RBAC Groups
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

Get RBAC Group
GET/v1/organizations/rbac_groups/{group_id}

Retrieve an RBAC Group by ID.

Create RBAC Group
POST/v1/organizations/rbac_groups

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

Update RBAC Group
POST/v1/organizations/rbac_groups/{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
DELETE/v1/organizations/rbac_groups/{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
GET/v1/organizations/rbac_groups/{group_id}/members

List members of an RBAC Group.

Add RBAC Group Member
POST/v1/organizations/rbac_groups/{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
DELETE/v1/organizations/rbac_groups/{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
GET/v1/organizations/rbac_roles

List RBAC Roles in the organization.

Get RBAC Role
GET/v1/organizations/rbac_roles/{role_id}

Retrieve an RBAC Role by ID.

BetaOrganizationRBAC RolesPermissions

List RBAC Role Permissions
GET/v1/organizations/rbac_roles/{role_id}/permissions

List the permissions an RBAC Role grants.