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 41 more
One of the following:
BetaAPIError object{ message, type }
message: string
defaultInternal server error
type: "api_error"
defaultapi_error
BetaAuthenticationError object{ message, type }
message: string
defaultAuthentication error
type: "authentication_error"
defaultauthentication_error
BetaBillingError object{ message, type }
message: string
defaultBilling error
type: "billing_error"
defaultbilling_error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
One of the following:
BetaErrorResponse object{ error, request_id, type }
error: BetaError
One of the following:
request_id: string or null
type: "error"
defaulterror
BetaGatewayTimeoutError object{ message, type }
message: string
defaultRequest timeout
type: "timeout_error"
defaulttimeout_error
BetaInvalidRequestError object{ message, type }
message: string
defaultInvalid request
type: "invalid_request_error"
defaultinvalid_request_error
BetaMonetaryAmount object{ amount, currency }

A monetary amount in a specific currency.

amount: string

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

currency: BetaCurrency

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

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

BetaModels

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

BetaMessages

Create a Message
POST/v1/messages
Count tokens in a Message
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
POST/v1/messages/batches
Retrieve a Message Batch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
GET/v1/messages/batches
Cancel a Message Batch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
GET/v1/messages/batches/{message_batch_id}/results

BetaAgents

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

BetaAgentsVersions

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

BetaEnvironments

Create Environment
POST/v1/environments
List Environments
GET/v1/environments
Get Environment
GET/v1/environments/{environment_id}
Update Environment
POST/v1/environments/{environment_id}
Delete Environment
DELETE/v1/environments/{environment_id}
Archive Environment
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

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

BetaSessions

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

BetaSessionsEvents

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

BetaSessionsResources

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

BetaSessionsThreads

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

BetaSessionsThreadsEvents

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

BetaDeployments

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

BetaDeployment Runs

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

BetaVaults

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

BetaVaultsCredentials

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

BetaMemory Stores

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

BetaMemory StoresMemories

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

BetaMemory StoresMemory Versions

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

BetaFiles

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

BetaSkills

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

BetaSkillsVersions

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

BetaWebhooks

Unwrap
Function
Parse Unverified
Function

BetaUser Profiles

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

BetaDreams

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

BetaTunnels

Create Tunnel
POST/v1/tunnels
Get Tunnel
GET/v1/tunnels/{tunnel_id}
List Tunnels
GET/v1/tunnels
Archive Tunnel
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
GET/v1/organizations/me

BetaOrganizationAPI Keys

List API Keys
GET/v1/organizations/api_keys
Get API Key
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
POST/v1/organizations/external_keys
List External Keys
GET/v1/organizations/external_keys
Get External Key
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
POST/v1/organizations/federation_issuers
List Federation Issuers
GET/v1/organizations/federation_issuers
Get Federation Issuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
POST/v1/organizations/federation_rules
List Federation Rules
GET/v1/organizations/federation_rules
Get Federation Rule
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
POST/v1/organizations/invites
List Invites
GET/v1/organizations/invites
Get Invite
GET/v1/organizations/invites/{invite_id}
Delete Invite
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
POST/v1/organizations/service_accounts
List Service Accounts
GET/v1/organizations/service_accounts
Get Service Account
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
GET/v1/organizations/users
Get User
GET/v1/organizations/users/{user_id}
Update User
POST/v1/organizations/users/{user_id}
Remove User
DELETE/v1/organizations/users/{user_id}

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

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
Create Service Account Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
GET/v1/organizations/rate_limits

BetaOrganizationCompliance Settings

Get Compliance Settings
GET/v1/organizations/compliance_settings
Update Compliance Settings
POST/v1/organizations/compliance_settings