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 52 more

Beta names you can send in the anthropic-beta header.

See Beta headers for how to send them and where to find the name a feature needs.

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

pattern^(0|[1-9]\d*)$
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
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Agents
GET/v1/agents
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Agent
GET/v1/agents/{agent_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update Agent
POST/v1/agents/{agent_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive Agent
POST/v1/agents/{agent_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaAgentsVersions

List Agent Versions
GET/v1/agents/{agent_id}/versions
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
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
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Sessions
GET/v1/sessions
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Session
GET/v1/sessions/{session_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update Session
POST/v1/sessions/{session_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete Session
DELETE/v1/sessions/{session_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive Session
POST/v1/sessions/{session_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaSessionsEvents

List Events
GET/v1/sessions/{session_id}/events
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Send Events
POST/v1/sessions/{session_id}/events
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Stream Events
GET/v1/sessions/{session_id}/events/stream
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaSessionsResources

Add Session Resource
POST/v1/sessions/{session_id}/resources
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Session Resources
GET/v1/sessions/{session_id}/resources
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Session Resource
GET/v1/sessions/{session_id}/resources/{resource_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update Session Resource
POST/v1/sessions/{session_id}/resources/{resource_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete Session Resource
DELETE/v1/sessions/{session_id}/resources/{resource_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaSessionsThreads

List Session Threads
GET/v1/sessions/{session_id}/threads
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Session Thread
GET/v1/sessions/{session_id}/threads/{thread_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive Session Thread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaSessionsThreadsEvents

List Session Thread Events
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Stream Session Thread Events
GET/v1/sessions/{session_id}/threads/{thread_id}/stream
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Create Deployment
POST/v1/deployments
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Deployments
GET/v1/deployments
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Deployment
GET/v1/deployments/{deployment_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update Deployment
POST/v1/deployments/{deployment_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive Deployment
POST/v1/deployments/{deployment_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Run Deployment Now
POST/v1/deployments/{deployment_id}/run
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Pause Deployment
POST/v1/deployments/{deployment_id}/pause
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Unpause Deployment
POST/v1/deployments/{deployment_id}/unpause
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Deployment Runs
GET/v1/deployment_runs
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Deployment Run
GET/v1/deployment_runs/{deployment_run_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaVaults

Create a Vault
POST/v1/vaults
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Vaults
GET/v1/vaults
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Retrieve a Vault
GET/v1/vaults/{vault_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update a Vault
POST/v1/vaults/{vault_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete a Vault
DELETE/v1/vaults/{vault_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive a Vault
POST/v1/vaults/{vault_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaVaultsCredentials

Create a Credential
POST/v1/vaults/{vault_id}/credentials
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Credentials
GET/v1/vaults/{vault_id}/credentials
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Retrieve a Credential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update a Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete a Credential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive a Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Validate an MCP OAuth Credential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Create a Memory Store
POST/v1/memory_stores
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Memory Stores
GET/v1/memory_stores
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Retrieve a Memory Store
GET/v1/memory_stores/{memory_store_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update a Memory Store
POST/v1/memory_stores/{memory_store_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete a Memory Store
DELETE/v1/memory_stores/{memory_store_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive a Memory Store
POST/v1/memory_stores/{memory_store_id}/archive
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaMemory StoresMemories

Create a Memory
POST/v1/memory_stores/{memory_store_id}/memories
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Memories
GET/v1/memory_stores/{memory_store_id}/memories
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Retrieve a Memory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update a Memory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Delete a Memory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers

BetaMemory StoresMemory Versions

List Memory Versions
GET/v1/memory_stores/{memory_store_id}/memory_versions
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Retrieve a Memory Version
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Redact a Memory Version
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact
Requires anthropic-beta: agent-memory-2026-07-22 or anthropic-beta: managed-agents-2026-04-01. How to send beta headers

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}
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}
Delete User Profile
DELETE/v1/user_profiles/{user_profile_id}
Create Enrollment URL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaUser ProfilesAction URLs

Create Action URL
POST/v1/user_profiles/{user_profile_id}/action_urls

BetaDreams

Create a Dream
POST/v1/dreams
Requires anthropic-beta: dreaming-2026-04-21. How to send beta headers

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
GET/v1/dreams
Requires anthropic-beta: dreaming-2026-04-21. How to send beta headers

List the dreams in the workspace, newest first.

Get a Dream
GET/v1/dreams/{dream_id}
Requires anthropic-beta: dreaming-2026-04-21. How to send beta headers

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

Cancel a Dream
POST/v1/dreams/{dream_id}/cancel
Requires anthropic-beta: dreaming-2026-04-21. How to send beta headers

Stop a pending or running dream.

Archive a Dream
POST/v1/dreams/{dream_id}/archive
Requires anthropic-beta: dreaming-2026-04-21. How to send beta headers

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

BetaTunnels

Create Tunnel
POST/v1/tunnels
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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}
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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}
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-06-22. How to send beta headers

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 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 a workspace's rate limits.

Set Workspace Rate Limits
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Set or clear rate-limit overrides for one rate-limit group in 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

[Legacy] Get a report of your organization's Messages API usage, aggregated into time buckets.

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

[Legacy] Get a report of your organization's Claude API costs in USD, aggregated into daily buckets.

BetaOrganizationMCP Tunnels

List Tunnels
Deprecated
GET/v1/organizations/tunnels
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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}
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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}
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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
Requires anthropic-beta: mcp-tunnels-2026-05-19. How to send beta headers

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.

BetaOrganizationAnalyticsSummaries

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

Get organization-wide activity summaries for a date range.

BetaOrganizationAnalyticsUsers

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

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

BetaOrganizationAnalyticsAppsChatProjects

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

Get per-project activity 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.

BetaOrganizationAnalyticsPlugins

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

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

BetaOrganizationAnalyticsSkills

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

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

BetaOrganizationAnalyticsArtifacts

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

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

BetaOrganizationAnalyticsUsage

Get Token Usage By Dimension
GET/v1/organizations/analytics/usage
Requires anthropic-beta: analytics-usage-cost-2026-08-24. How to send beta headers

Get token usage across a date range, broken out by dimension.

BetaOrganizationAnalyticsCost

Get Cost By Dimension
GET/v1/organizations/analytics/cost
Requires anthropic-beta: analytics-usage-cost-2026-08-24. How to send beta headers

Get cost in USD across a date range, broken out by dimension.

BetaOrganizationAnalyticsUsage Report

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

[Legacy] Get token usage over time across a date range.

BetaOrganizationAnalyticsUser Usage Report

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

[Legacy] Get per-user token usage across a date range.

BetaOrganizationAnalyticsCost Report

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

[Legacy] Get cost in USD over time across a date range.

BetaOrganizationAnalyticsUser Cost Report

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

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

BetaOrganizationSpend Limits

Set Spend Limit
POST/v1/organizations/spend_limits

Set a spend limit.

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 spend limit.

List Spend Limits
GET/v1/organizations/spend_limits
Requires anthropic-beta: spend-limit-reads-2026-09-26. How to send beta headers

List the organization's spend limits.

BetaOrganizationSpend LimitsEffective

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

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

List RBAC Groups
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

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

Retrieve an RBAC Group by ID.

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

List members of an RBAC Group.

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

List RBAC Roles in the organization.

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

Retrieve an RBAC Role by ID.

BetaOrganizationRBAC RolesPermissions

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

List the permissions an RBAC Role grants.

BetaOrganizationPlugins

Create Plugin
POST/v1/organizations/plugins
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

Get Plugin
GET/v1/organizations/plugins/{plugin_id}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

Retrieve a Plugin by ID.

Update Plugin
POST/v1/organizations/plugins/{plugin_id}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
GET/v1/organizations/plugins
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
DELETE/v1/organizations/plugins/{plugin_id}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
POST/v1/organizations/plugins/{plugin_id}/versions
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
GET/v1/organizations/plugins/{plugin_id}/versions
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

List a Plugin's versions, newest first.

Get Plugin Version
GET/v1/organizations/plugins/{plugin_id}/versions/{version}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

Download Plugin Version Archive
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
GET/v1/organizations/plugins/{plugin_id}/installation_settings
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

Set Plugin Installation Setting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

Remove Plugin Installation Setting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

BetaOrganizationPluginsShares

List Plugin Shares
GET/v1/organizations/plugins/{plugin_id}/shares
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
GET/v1/organizations/plugin_marketplaces
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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

Get Plugin Marketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
POST/v1/organizations/plugin_marketplaces/validate_repository
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
POST/v1/organizations/plugin_marketplaces/validate_archive
Requires anthropic-beta: ce-plugins-2026-09-01. How to send beta headers

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
POST/v1/organizations/telemetry_destinations
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

Register an OpenTelemetry destination for the organization.

List Telemetry Destinations
GET/v1/organizations/telemetry_destinations
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

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

Retrieve a Telemetry Destination
GET/v1/organizations/telemetry_destinations/{destination_id}
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

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

Update a Telemetry Destination
POST/v1/organizations/telemetry_destinations/{destination_id}
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

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

Delete a Telemetry Destination
DELETE/v1/organizations/telemetry_destinations/{destination_id}
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

Delete a destination and its workspace list.

Test a Telemetry Destination
POST/v1/organizations/telemetry_destinations/{destination_id}/test
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

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
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

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

Add a Telemetry Destination Workspace
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

Add one workspace to a destination's workspace list.

Remove a Telemetry Destination Workspace
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Requires anthropic-beta: telemetry-destinations-2026-08-11. How to send beta headers

Remove one workspace from a destination's workspace list.

BetaOrganizationWebhooks

Create Organization Webhook Endpoint
POST/v1/organizations/webhooks
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Create an organization webhook endpoint.

List Organization Webhook Endpoints
GET/v1/organizations/webhooks
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

List the organization's webhook endpoints.

Get Organization Webhook Endpoint
GET/v1/organizations/webhooks/{webhook_endpoint_id}
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Retrieve an organization webhook endpoint by ID.

Update Organization Webhook Endpoint
POST/v1/organizations/webhooks/{webhook_endpoint_id}
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Update an organization webhook endpoint. Only the fields you send are changed.

Delete Organization Webhook Endpoint
DELETE/v1/organizations/webhooks/{webhook_endpoint_id}
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Delete an organization webhook endpoint.

Regenerate Organization Webhook Endpoint Signing Secret
POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret
Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Replace an organization webhook endpoint's signing secret. The old secret stops working immediately. The new secret is returned only in this response.

BetaOrganizationClaude TagSlack Channels

Set Up Slack Channel
POST/v1/organizations/claude_tag/slack_channels
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Set a Slack channel up for Claude Tag and return it with its identifier. If the channel is already set up, whether in claude.ai, by Claude's first use in it or by an earlier request, the existing channel is returned, so the request can be repeated. settings, when sent, is applied as an update applies it. Before a channel is set up, Claude's Slack app confirms with Slack that the channel is in the workspace, is not archived and is visible to the app; a channel that fails the confirmation returns 404. Setting the channel up and applying settings are two steps: when the second is refused, the response is the refusal, the channel stays set up with every setting unset, and the error's details.slack_channel_id holds the channel's identifier.

List Slack Channels
GET/v1/organizations/claude_tag/slack_channels
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

List the set-up Slack channels of one Slack workspace, newest first by created_at. A channel that is not set up is not listed: Slack holds the full list of a workspace's channels. Pass slack_channel_id as well to look one channel up by its Slack identifiers: data then holds that channel, or is empty when it is not set up, and limit and page are ignored. A workspace that the organization owns only through a Slack Enterprise Grid returns 404 until it is set up. With include_inherited=true each channel's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Channel
GET/v1/organizations/claude_tag/slack_channels/{id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Get one Slack channel and its settings. By default settings holds what the channel itself stores: a setting that is null there is not set on the channel and is inherited. With include_inherited=true, settings holds what applies in the channel once the settings levels above it are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from, so a caller tells the channel's own value from an inherited one by its source, not by whether it is null.

Update Slack Channel
POST/v1/organizations/claude_tag/slack_channels/{id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Change the settings a Slack channel stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the channel inherits it. If any value is refused, no setting in the request is stored. A group direct message takes no settings and returns 400.

Remove Slack Channel
DELETE/v1/organizations/claude_tag/slack_channels/{id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Remove a Slack channel from Claude Tag. This deletes the channel's stored settings and its Bundle Targets at once, and then, in the background, the channel's sessions and their transcripts, its memory, its routines and the artifacts published from it. None of it can be restored. The channel in Slack and its messages are unchanged. The request is refused with 400 and error.details.error_code slack_channel_enabled while enabled resolves to true for the channel, as a read with include_inherited=true returns it: set enabled to false on the channel first. This guards against removing a channel in use by mistake; it is not a way to keep Claude out, because the removal deletes the channel's own enabled: false with its other settings, after which the channel inherits again and Claude's next use of it can set it up anew with a new identifier. The identifier returns 404 as soon as the request returns, so a repeated removal returns 404. A group direct message returns 400, and so does a channel that holds configuration this API does not manage.

BetaOrganizationClaude TagSlack Workspaces

List Slack Workspaces
GET/v1/organizations/claude_tag/slack_workspaces
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

List the set-up Slack workspaces the organization owns, newest first by created_at. Pass slack_workspace_id to look one workspace up by its Slack identifier: data then holds that workspace, or is empty when it is not set up. A workspace of a Slack Enterprise Grid the organization has connected returns 404 until it is set up. With include_inherited=true each workspace's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Workspace
GET/v1/organizations/claude_tag/slack_workspaces/{id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Get one Slack workspace and its settings. By default settings holds what the workspace itself stores: a setting that is null there is not set on the workspace and is inherited. With include_inherited=true, settings holds what applies in the workspace once the organization's Slack defaults are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from.

Update Slack Workspace
POST/v1/organizations/claude_tag/slack_workspaces/{id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Change the settings a Slack workspace stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the workspace inherits it. If any value is refused, no setting in the request is stored.

BetaOrganizationClaude TagBundles

List Bundles
GET/v1/organizations/claude_tag/bundles
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

List the organization's Bundles, newest first by created_at. A Bundle that Claude Tag manages for itself is not listed.

Get Bundle
GET/v1/organizations/claude_tag/bundles/{bundle_id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Get one Bundle. What the Bundle grants (connectors, repositories and credentials) is never returned.

BetaOrganizationClaude TagBundlesTargets

List Bundle Targets
GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

List the Slack channels and Slack workspaces a Bundle is attached to, newest first by created_at. Only channels and workspaces the organization owns are listed; a Bundle that is attached to anything else has no Bundle Target for it.

Attach Bundle
POST/v1/organizations/claude_tag/bundles/{bundle_id}/targets
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Attach a Bundle to a Slack channel or a Slack workspace. A Bundle attached to a workspace can be used in the workspace and in every channel in it. Attaching a Bundle to a channel or workspace it is already attached to returns the existing Bundle Target. The channel or workspace must be set up: attaching never sets a channel up. A group direct message takes no Bundle and returns 400.

Get Bundle Target
GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Get one Bundle Target. Returns 404 when target_id is the identifier of another Bundle's Bundle Target, or the Bundle Target was detached.

Detach Bundle
DELETE/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}
Requires anthropic-beta: experimental-claude-tag-2026-10-21. How to send beta headers

Detach a Bundle from a Slack channel or a Slack workspace. A repeated detach returns 404.