Claude Platform Docs

Beta

Models
beta_api_error: object{ type: "api_error", message }
type: "api_error"
message: string
beta_authentication_error: object{ type: "authentication_error", message }
type: "authentication_error"
message: string
beta_billing_error: object{ type: "billing_error", message }
type: "billing_error"
message: string
beta_currency: "USD"
"USD"
beta_error_response: object{ type: "error", error, request_id }
beta_gateway_timeout_error: object{ type: "timeout_error", message }
type: "timeout_error"
message: string
beta_invalid_request_error: object{ type: "invalid_request_error", message }
type: "invalid_request_error"
message: string
beta_monetary_amount: 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: "USD"

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.

beta_not_found_error: object{ type: "not_found_error", message }
type: "not_found_error"
message: string
beta_overloaded_error: object{ type: "overloaded_error", message }
type: "overloaded_error"
message: string
beta_permission_error: object{ type: "permission_error", message }
type: "permission_error"
message: string
beta_rate_limit_error: object{ type: "rate_limit_error", message }
type: "rate_limit_error"
message: string

BetaModels

List Models
$ ant beta:models list
GET/v1/models

List available models.

Get a Model
$ ant beta:models retrieve
GET/v1/models/{model_id}

Get a specific model.

BetaMessages

Create a Message
$ ant beta:messages create
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
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

Count the number of tokens in a Message.

BetaMessagesBatches

Create a Message Batch
$ ant beta:messages:batches create
POST/v1/messages/batches

Send a batch of Message creation requests.

Retrieve a Message Batch
$ ant beta:messages:batches retrieve
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
$ ant beta:messages:batches list
GET/v1/messages/batches

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

Cancel a Message Batch
$ ant beta:messages:batches cancel
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
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

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

BetaAgents

Create Agent
$ ant beta:agents create
POST/v1/agents
List Agents
$ ant beta:agents list
GET/v1/agents
Get Agent
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Update Agent
$ ant beta:agents update
POST/v1/agents/{agent_id}
Archive Agent
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
$ ant beta:environments create
POST/v1/environments

Create a new environment with the specified configuration.

List Environments
$ ant beta:environments list
GET/v1/environments

List environments with pagination support.

Get Environment
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}

Retrieve a specific environment by ID.

Update Environment
$ ant beta:environments update
POST/v1/environments/{environment_id}

Update an existing environment's configuration.

Delete Environment
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}

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

Archive Environment
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

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

BetaEnvironmentsWork

Get Work Item
$ ant beta:environments:work retrieve
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
$ ant beta:environments:work poll
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
$ ant beta:environments:work ack
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
$ ant beta:environments:work 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
$ ant beta:environments:work stop
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
$ ant beta:environments:work list
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
$ ant beta:environments:work update
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
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

Get statistics about the work queue for an environment.

BetaSessions

Create Session
$ ant beta:sessions create
POST/v1/sessions
List Sessions
$ ant beta:sessions list
GET/v1/sessions
Get Session
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Update Session
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Delete Session
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Archive Session
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
Send Events
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
Stream Events
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
List Session Resources
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Get Session Resource
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
Get Session Thread
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
$ ant beta:sessions:threads:events list
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
$ ant beta:sessions:threads:events stream
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
$ ant beta:deployments create
POST/v1/deployments
List Deployments
$ ant beta:deployments list
GET/v1/deployments
Get Deployment
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
Update Deployment
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
Archive Deployment
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
Pause Deployment
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Get Deployment Run
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
$ ant beta:vaults create
POST/v1/vaults
List Vaults
$ ant beta:vaults list
GET/v1/vaults
Get Vault
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Update Vault
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Delete Vault
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Archive Vault
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
List Credentials
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Get Credential
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
$ ant beta:memory-stores create
POST/v1/memory_stores
List memory stores
$ ant beta:memory-stores list
GET/v1/memory_stores
Retrieve a memory store
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Update a memory store
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
List memories
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
$ ant beta:files upload
POST/v1/files
List Files
$ ant beta:files list
GET/v1/files
Download File
$ ant beta:files download
GET/v1/files/{file_id}/content
Get File Metadata
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Delete File
$ ant beta:files delete
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
$ ant beta:skills create
POST/v1/skills
List Skills
$ ant beta:skills list
GET/v1/skills
Get Skill
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Delete Skill
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
List Skill Versions
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content

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

Get Skill Version
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

BetaUser Profiles

Create User Profile
$ ant beta:user-profiles create
POST/v1/user_profiles
List User Profiles
$ ant beta:user-profiles list
GET/v1/user_profiles
Get User Profile
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Update User Profile
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
$ ant beta:dreams create
POST/v1/dreams

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

List Dreams
$ ant beta:dreams list
GET/v1/dreams

List the dreams in the workspace, newest first.

Get a Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}

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

Cancel a Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel

Stop a pending or running dream.

Archive a Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

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

BetaTunnels

Create Tunnel
$ ant beta:tunnels create
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
$ ant beta:tunnels retrieve
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
$ ant beta:tunnels list
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
$ ant beta:tunnels archive
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
$ ant beta:tunnels reveal-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
$ ant beta:tunnels rotate-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
$ ant beta:tunnels:certificates create
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
$ ant beta:tunnels:certificates retrieve
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
$ ant beta:tunnels:certificates list
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
$ ant beta:tunnels:certificates archive
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
$ ant beta:organization retrieve
GET/v1/organizations/me

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

BetaOrganizationAPI Keys

List API Keys
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
$ ant beta:organization:api-keys retrieve
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
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys

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

List External Keys
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}

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

Update External Key
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

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

Delete External Key
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

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

BetaOrganizationFederationIssuers

Create Federation Issuer
$ ant beta:organization:federation:issuers create
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
$ ant beta:organization:federation:issuers list
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
$ ant beta:organization:federation:issuers retrieve
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
$ ant beta:organization:federation:issuers update
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
$ ant beta:organization:federation:issuers archive
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
$ ant beta:organization:federation:rules create
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
$ ant beta:organization:federation:rules list
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
$ ant beta:organization:federation:rules retrieve
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
$ ant beta:organization:federation:rules update
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
$ ant beta:organization:federation:rules archive
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
$ ant beta:organization:federation:rules:workspaces add
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
$ ant beta:organization:federation:rules:workspaces list
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
$ ant beta:organization:federation:rules:workspaces remove
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
$ ant beta:organization:invites create
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
$ ant beta:organization:invites list
GET/v1/organizations/invites

List the organization's invites.

Get Invite
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

BetaOrganizationService Accounts

Create Service Account
$ ant beta:organization:service-accounts create
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
$ ant beta:organization:service-accounts list
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
$ ant beta:organization:service-accounts retrieve
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
$ ant beta:organization:service-accounts update
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
$ ant beta:organization:service-accounts archive
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
$ ant beta:organization:service-accounts:workspaces add
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
$ ant beta:organization:service-accounts:workspaces list
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
$ ant beta:organization:service-accounts:workspaces remove
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
$ ant beta:organization:users list
GET/v1/organizations/users

List the organization's members.

Get User
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

BetaOrganizationWorkspaces

List Workspaces
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Create Workspace
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Get Workspace
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

BetaOrganizationWorkspacesMembers

List Workspace Members
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
$ ant beta:organization:workspaces:service-accounts list
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
$ ant beta:organization:workspaces:service-accounts add
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
$ ant beta:organization:workspaces:service-accounts retrieve
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
$ ant beta:organization:workspaces:service-accounts update
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
$ ant beta:organization:workspaces:service-accounts remove
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
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BetaOrganizationCompliance Settings

Get Compliance Settings
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.

BetaOrganizationAnalyticsSummaries

Get Activity Summaries
$ ant beta:organization:analytics:summaries list
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BetaOrganizationAnalyticsUsers

List User Activity
$ ant beta:organization:analytics:users list
GET/v1/organizations/analytics/users

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

BetaOrganizationAnalyticsAppsChatProjects

Get Chat Project Usage
$ ant beta:organization:analytics:apps:chat:projects list
GET/v1/organizations/analytics/apps/chat/projects

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

BetaOrganizationAnalyticsConnectors

Get Connector Usage
$ ant beta:organization:analytics:connectors list
GET/v1/organizations/analytics/connectors

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

BetaOrganizationAnalyticsPlugins

Get Plugin Usage
$ ant beta:organization:analytics:plugins list
GET/v1/organizations/analytics/plugins

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

BetaOrganizationAnalyticsSkills

Get Skill Usage
$ ant beta:organization:analytics:skills list
GET/v1/organizations/analytics/skills

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

BetaOrganizationAnalyticsArtifacts

Get Artifact Activity
$ ant beta:organization:analytics:artifacts list
GET/v1/organizations/analytics/artifacts

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

BetaOrganizationAnalyticsUsage Report

Get Token Usage Over Time
$ ant beta:organization:analytics:usage-report list
GET/v1/organizations/analytics/usage_report

Get token usage over time across a date range.

BetaOrganizationAnalyticsUser Usage Report

Get Per-User Token Usage
$ ant beta:organization:analytics:user-usage-report list
GET/v1/organizations/analytics/user_usage_report

Get per-user token usage across a date range.

BetaOrganizationAnalyticsCost Report

Get Cost Over Time
$ ant beta:organization:analytics:cost-report list
GET/v1/organizations/analytics/cost_report

Get cost in USD over time across a date range.

BetaOrganizationAnalyticsUser Cost Report

Get Per-User Cost
$ ant beta:organization:analytics:user-cost-report list
GET/v1/organizations/analytics/user_cost_report

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

BetaOrganizationSpend Limits

Set Spend Limit
$ ant beta:organization:spend-limits set
POST/v1/organizations/spend_limits

Set a spend limit.

Get Spend Limit
$ ant beta:organization:spend-limits retrieve
GET/v1/organizations/spend_limits/{spend_limit_id}

Retrieve a spend limit by ID.

Delete Spend Limit
$ ant beta:organization:spend-limits delete
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Delete a spend limit.

List Spend Limits
$ ant beta:organization:spend-limits list
GET/v1/organizations/spend_limits

List the organization's spend limits.

BetaOrganizationSpend LimitsEffective

List Effective Spend Limits
$ ant beta:organization:spend-limits:effective list
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
$ ant beta:organization:spend-limits:increase-requests list
GET/v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Get Spend Limit Increase Request
$ ant beta:organization:spend-limits:increase-requests retrieve
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

Approve Spend Limit Increase Request
$ ant beta:organization:spend-limits:increase-requests approve
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
$ ant beta:organization:spend-limits:increase-requests deny
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
$ ant beta:organization:rbac-groups create
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
$ ant beta:organization:rbac-groups list
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

Get RBAC Group
$ ant beta:organization:rbac-groups retrieve
GET/v1/organizations/rbac_groups/{rbac_group_id}

Retrieve an RBAC Group by ID.

Update RBAC Group
$ ant beta:organization:rbac-groups update
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
$ ant beta:organization:rbac-groups delete
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
$ ant beta:organization:rbac-groups:members list
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

List members of an RBAC Group.

Add RBAC Group Member
$ ant beta:organization:rbac-groups:members add
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
$ ant beta:organization:rbac-groups:members remove
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
$ ant beta:organization:rbac-roles list
GET/v1/organizations/rbac_roles

List RBAC Roles in the organization.

Get RBAC Role
$ ant beta:organization:rbac-roles retrieve
GET/v1/organizations/rbac_roles/{rbac_role_id}

Retrieve an RBAC Role by ID.

BetaOrganizationRBAC RolesPermissions

List RBAC Role Permissions
$ ant beta:organization:rbac-roles:permissions list
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

List the permissions an RBAC Role grants.

BetaOrganizationPlugins

Create Plugin
$ ant beta:organization:plugins create
POST/v1/organizations/plugins

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

Get Plugin
$ ant beta:organization:plugins retrieve
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
$ ant beta:organization:plugins update
POST/v1/organizations/plugins/{plugin_id}

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

List Plugins
$ ant beta:organization:plugins list
GET/v1/organizations/plugins

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

Delete Plugin
$ ant beta:organization:plugins delete
DELETE/v1/organizations/plugins/{plugin_id}

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

BetaOrganizationPluginsVersions

Create Plugin Version
$ ant beta:organization:plugins:versions create
POST/v1/organizations/plugins/{plugin_id}/versions

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

List Plugin Versions
$ ant beta:organization:plugins:versions list
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
$ ant beta:organization:plugins:versions retrieve
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

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

Download Plugin Version Archive
$ ant beta:organization:plugins:versions download
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

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

BetaOrganizationPluginsInstallation Settings

List Plugin Installation Settings
$ ant beta:organization:plugins:installation-settings list
GET/v1/organizations/plugins/{plugin_id}/installation_settings

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

Set Plugin Installation Setting
$ ant beta:organization:plugins:installation-settings set
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

Remove Plugin Installation Setting
$ ant beta:organization:plugins:installation-settings remove
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

BetaOrganizationPluginsShares

List Plugin Shares
$ ant beta:organization:plugins:shares list
GET/v1/organizations/plugins/{plugin_id}/shares

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

BetaOrganizationPlugin Marketplaces

List Plugin Marketplaces
$ ant beta:organization:plugin-marketplaces list
GET/v1/organizations/plugin_marketplaces

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

Get Plugin Marketplace
$ ant beta:organization:plugin-marketplaces retrieve
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
$ ant beta:organization:plugin-marketplaces update
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

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

Validate Plugin Marketplace Repository
$ ant beta:organization:plugin-marketplaces validate-repository
POST/v1/organizations/plugin_marketplaces/validate_repository

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

Validate Plugin Marketplace Archive
$ ant beta:organization:plugin-marketplaces validate-archive
POST/v1/organizations/plugin_marketplaces/validate_archive

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