Claude Platform Docs

Beta

Models
beta_api_error: object{ message, type }
message: string
type: "api_error"
beta_authentication_error: object{ message, type }
message: string
type: "authentication_error"
beta_billing_error: object{ message, type }
message: string
type: "billing_error"
beta_currency: "USD"
"USD"
beta_error: BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
beta_error_response: object{ error, request_id, type }
beta_gateway_timeout_error: object{ message, type }
message: string
type: "timeout_error"
beta_invalid_request_error: object{ message, type }
message: string
type: "invalid_request_error"
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{ message, type }
message: string
type: "not_found_error"
beta_overloaded_error: object{ message, type }
message: string
type: "overloaded_error"
beta_permission_error: object{ message, type }
message: string
type: "permission_error"
beta_rate_limit_error: object{ message, type }
message: string
type: "rate_limit_error"

BetaModels

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

BetaMessages

Create a Message
$ ant beta:messages create
POST/v1/messages
Count tokens in a Message
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
$ ant beta:messages:batches create
POST/v1/messages/batches
Retrieve a Message Batch
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
List Message Batches
$ ant beta:messages:batches list
GET/v1/messages/batches
Cancel a Message Batch
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
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

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
List Environments
$ ant beta:environments list
GET/v1/environments
Get Environment
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Update Environment
$ ant beta:environments update
POST/v1/environments/{environment_id}
Delete Environment
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Archive Environment
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

Get Work Item
$ ant beta:environments:work retrieve
GET/v1/environments/{environment_id}/work/{work_id}
Poll for Work
$ ant beta:environments:work poll
GET/v1/environments/{environment_id}/work/poll
Acknowledge Work
$ ant beta:environments:work ack
POST/v1/environments/{environment_id}/work/{work_id}/ack
Record Heartbeat
$ ant beta:environments:work heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Stop Work
$ ant beta:environments:work stop
POST/v1/environments/{environment_id}/work/{work_id}/stop
List Work Items
$ ant beta:environments:work list
GET/v1/environments/{environment_id}/work
Update Work Item
$ ant beta:environments:work update
POST/v1/environments/{environment_id}/work/{work_id}
Get Queue Statistics
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

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
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
List Dreams
$ ant beta:dreams list
GET/v1/dreams
Get a Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
Cancel a Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
$ ant beta:tunnels create
POST/v1/tunnels
Get Tunnel
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
List Tunnels
$ ant beta:tunnels list
GET/v1/tunnels
Archive Tunnel
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
$ ant beta:organization retrieve
GET/v1/organizations/me

BetaOrganizationAPI Keys

List API Keys
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Get API Key
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
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
List External Keys
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Get External Key
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
List Federation Issuers
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Get Federation Issuer
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
List Federation Rules
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Get Federation Rule
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
$ ant beta:organization:invites create
POST/v1/organizations/invites
List Invites
$ ant beta:organization:invites list
GET/v1/organizations/invites
Get Invite
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Delete Invite
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
List Service Accounts
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Get Service Account
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
$ ant beta:organization:users list
GET/v1/organizations/users
Get User
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Update User
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Remove User
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

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

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
Create Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits