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

Beta模型

列出模型
GET/v1/models
获取模型
GET/v1/models/{model_id}

Beta消息

创建消息
POST/v1/messages
计算消息中的令牌数
POST/v1/messages/count_tokens

Beta消息批处理

创建消息批次
POST/v1/messages/batches
检索消息批次
GET/v1/messages/batches/{message_batch_id}
列出消息批次
GET/v1/messages/batches
取消消息批次
POST/v1/messages/batches/{message_batch_id}/cancel
删除消息批次
DELETE/v1/messages/batches/{message_batch_id}
检索消息批次结果
GET/v1/messages/batches/{message_batch_id}/results

Beta代理

创建代理
POST/v1/agents
列出代理
GET/v1/agents
获取代理
GET/v1/agents/{agent_id}
更新代理
POST/v1/agents/{agent_id}
归档代理
POST/v1/agents/{agent_id}/archive

Beta代理版本

列出代理版本
GET/v1/agents/{agent_id}/versions

Beta环境

创建环境
POST/v1/environments
列出环境
GET/v1/environments
获取环境
GET/v1/environments/{environment_id}
更新环境
POST/v1/environments/{environment_id}
删除环境
DELETE/v1/environments/{environment_id}
归档环境
POST/v1/environments/{environment_id}/archive

Beta环境工作

获取工作项
GET/v1/environments/{environment_id}/work/{work_id}
轮询工作
GET/v1/environments/{environment_id}/work/poll
确认工作
POST/v1/environments/{environment_id}/work/{work_id}/ack
记录心跳
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
停止工作
POST/v1/environments/{environment_id}/work/{work_id}/stop
列出工作项
GET/v1/environments/{environment_id}/work
更新工作项
POST/v1/environments/{environment_id}/work/{work_id}
获取队列统计信息
GET/v1/environments/{environment_id}/work/stats

Beta会话

创建会话
POST/v1/sessions
列出会话
GET/v1/sessions
获取会话
GET/v1/sessions/{session_id}
更新会话
POST/v1/sessions/{session_id}
删除会话
DELETE/v1/sessions/{session_id}
归档会话
POST/v1/sessions/{session_id}/archive

Beta会话事件

列出事件
GET/v1/sessions/{session_id}/events
发送事件
POST/v1/sessions/{session_id}/events
流式传输事件
GET/v1/sessions/{session_id}/events/stream

Beta会话资源

添加会话资源
POST/v1/sessions/{session_id}/resources
列出会话资源
GET/v1/sessions/{session_id}/resources
获取会话资源
GET/v1/sessions/{session_id}/resources/{resource_id}
更新会话资源
POST/v1/sessions/{session_id}/resources/{resource_id}
删除会话资源
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta会话线程

列出会话线程
GET/v1/sessions/{session_id}/threads
获取会话线程
GET/v1/sessions/{session_id}/threads/{thread_id}
归档会话线程
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta会话线程事件

列出会话线程事件
GET/v1/sessions/{session_id}/threads/{thread_id}/events
流式传输会话线程事件
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

Beta部署

创建部署
POST/v1/deployments
列出部署
GET/v1/deployments
获取部署
GET/v1/deployments/{deployment_id}
更新部署
POST/v1/deployments/{deployment_id}
归档部署
POST/v1/deployments/{deployment_id}/archive
立即运行部署
POST/v1/deployments/{deployment_id}/run
暂停部署
POST/v1/deployments/{deployment_id}/pause
取消暂停部署
POST/v1/deployments/{deployment_id}/unpause
列出部署运行
GET/v1/deployment_runs
获取部署运行
GET/v1/deployment_runs/{deployment_run_id}

Beta保管库

创建保管库
POST/v1/vaults
列出保管库
GET/v1/vaults
获取保管库
GET/v1/vaults/{vault_id}
更新保管库
POST/v1/vaults/{vault_id}
删除保管库
DELETE/v1/vaults/{vault_id}
归档保管库
POST/v1/vaults/{vault_id}/archive

Beta保管库凭证

创建凭证
POST/v1/vaults/{vault_id}/credentials
列出凭证
GET/v1/vaults/{vault_id}/credentials
获取凭证
GET/v1/vaults/{vault_id}/credentials/{credential_id}
更新凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}
删除凭证
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
归档凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
验证凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
创建记忆存储
POST/v1/memory_stores
列出记忆存储
GET/v1/memory_stores
检索记忆存储
GET/v1/memory_stores/{memory_store_id}
更新记忆存储
POST/v1/memory_stores/{memory_store_id}
删除记忆存储
DELETE/v1/memory_stores/{memory_store_id}
归档记忆存储
POST/v1/memory_stores/{memory_store_id}/archive

Beta记忆存储记忆

创建记忆
POST/v1/memory_stores/{memory_store_id}/memories
列出记忆
GET/v1/memory_stores/{memory_store_id}/memories
检索记忆
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新记忆
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
删除记忆
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta记忆存储记忆版本

列出记忆版本
GET/v1/memory_stores/{memory_store_id}/memory_versions
检索记忆版本
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
对记忆版本进行脱敏
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta文件

上传文件
POST/v1/files
列出文件
GET/v1/files
下载文件
GET/v1/files/{file_id}/content
获取文件元数据
GET/v1/files/{file_id}
删除文件
DELETE/v1/files/{file_id}

Beta技能

创建技能
POST/v1/skills
列出技能
GET/v1/skills
获取技能
GET/v1/skills/{skill_id}
删除技能
DELETE/v1/skills/{skill_id}

Beta技能版本

创建技能版本
POST/v1/skills/{skill_id}/versions
列出技能版本
GET/v1/skills/{skill_id}/versions
下载技能版本内容
GET/v1/skills/{skill_id}/versions/{version}/content
获取技能版本
GET/v1/skills/{skill_id}/versions/{version}
删除技能版本
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhook

Unwrap
Function
Parse Unverified
Function
创建用户配置文件
POST/v1/user_profiles
列出用户配置文件
GET/v1/user_profiles
获取用户配置文件
GET/v1/user_profiles/{user_profile_id}
更新用户配置文件
POST/v1/user_profiles/{user_profile_id}
创建注册 URL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

创建 Dream
POST/v1/dreams
列出 Dream
GET/v1/dreams
获取 Dream
GET/v1/dreams/{dream_id}
取消 Dream
POST/v1/dreams/{dream_id}/cancel
归档 Dream
POST/v1/dreams/{dream_id}/archive

Beta隧道

创建隧道
POST/v1/tunnels
获取隧道
GET/v1/tunnels/{tunnel_id}
列出隧道
GET/v1/tunnels
归档隧道
POST/v1/tunnels/{tunnel_id}/archive
显示隧道令牌
POST/v1/tunnels/{tunnel_id}/reveal_token
轮换隧道令牌
POST/v1/tunnels/{tunnel_id}/rotate_token

Beta隧道证书

创建隧道证书
POST/v1/tunnels/{tunnel_id}/certificates
获取隧道证书
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
列出隧道证书
GET/v1/tunnels/{tunnel_id}/certificates
归档隧道证书
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Beta组织

获取当前组织
GET/v1/organizations/me

Beta组织API 密钥

列出 API 密钥
GET/v1/organizations/api_keys
获取 API 密钥
GET/v1/organizations/api_keys/{api_key_id}
更新 API 密钥
POST/v1/organizations/api_keys/{api_key_id}

Beta组织外部密钥

创建外部密钥
POST/v1/organizations/external_keys
列出外部密钥
GET/v1/organizations/external_keys
获取外部密钥
GET/v1/organizations/external_keys/{external_key_id}
更新外部密钥
POST/v1/organizations/external_keys/{external_key_id}
删除外部密钥
DELETE/v1/organizations/external_keys/{external_key_id}
验证外部密钥
POST/v1/organizations/external_keys/{external_key_id}/validate

Beta组织联合颁发者

创建联合签发者
POST/v1/organizations/federation_issuers
列出联合签发者
GET/v1/organizations/federation_issuers
获取联合签发者
GET/v1/organizations/federation_issuers/{federation_issuer_id}
更新联合签发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}
归档联合签发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Beta组织联合规则

创建联合规则
POST/v1/organizations/federation_rules
列出联合规则
GET/v1/organizations/federation_rules
获取联合规则
GET/v1/organizations/federation_rules/{federation_rule_id}
更新联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}
归档联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Beta组织联合规则工作区

添加联合规则工作区
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
列出联合规则工作区
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
移除联合规则工作区
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Beta组织邀请

创建邀请
POST/v1/organizations/invites
列出邀请
GET/v1/organizations/invites
获取邀请
GET/v1/organizations/invites/{invite_id}
删除邀请
DELETE/v1/organizations/invites/{invite_id}

Beta组织服务账户

创建服务账户
POST/v1/organizations/service_accounts
列出服务账户
GET/v1/organizations/service_accounts
获取服务账户
GET/v1/organizations/service_accounts/{service_account_id}
更新服务账户
POST/v1/organizations/service_accounts/{service_account_id}
归档服务账户
POST/v1/organizations/service_accounts/{service_account_id}/archive

Beta组织服务账户工作区

将工作区添加到服务账户
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
列出服务账户的工作区
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
从服务账户移除工作区
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Beta组织用户

列出用户
GET/v1/organizations/users
获取用户
GET/v1/organizations/users/{user_id}
更新用户
POST/v1/organizations/users/{user_id}
移除用户
DELETE/v1/organizations/users/{user_id}

Beta组织工作区

列出工作区
GET/v1/organizations/workspaces
创建工作区
POST/v1/organizations/workspaces
获取工作区
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta组织工作区速率限制

列出工作区速率限制
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Beta组织工作区成员

列出工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta组织工作区服务账户

列出服务账户工作区成员
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
创建服务账户工作区成员
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
获取服务账户工作区成员
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
更新服务账户工作区成员
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
删除服务账户工作区成员
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Beta组织速率限制

列出组织速率限制
GET/v1/organizations/rate_limits

Beta组织合规设置

获取合规设置
GET/v1/organizations/compliance_settings
更新合规设置
POST/v1/organizations/compliance_settings