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"

Beta模型

列出模型
$ ant beta:models list
GET/v1/models
获取模型
$ ant beta:models retrieve
GET/v1/models/{model_id}

Beta消息

创建消息
$ ant beta:messages create
POST/v1/messages
计算消息中的令牌数
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

Beta消息批处理

创建消息批次
$ ant beta:messages:batches create
POST/v1/messages/batches
检索消息批次
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
列出消息批次
$ ant beta:messages:batches list
GET/v1/messages/batches
取消消息批次
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
删除消息批次
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
检索消息批次结果
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

Beta代理

创建代理
$ ant beta:agents create
POST/v1/agents
列出代理
$ ant beta:agents list
GET/v1/agents
获取代理
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
更新代理
$ ant beta:agents update
POST/v1/agents/{agent_id}
归档代理
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

Beta代理版本

列出代理版本
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

Beta环境

创建环境
$ ant beta:environments create
POST/v1/environments
列出环境
$ ant beta:environments list
GET/v1/environments
获取环境
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
更新环境
$ ant beta:environments update
POST/v1/environments/{environment_id}
删除环境
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
归档环境
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

Beta环境工作

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

Beta会话

创建会话
$ ant beta:sessions create
POST/v1/sessions
列出会话
$ ant beta:sessions list
GET/v1/sessions
获取会话
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
更新会话
$ ant beta:sessions update
POST/v1/sessions/{session_id}
删除会话
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
归档会话
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

Beta会话事件

列出事件
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
发送事件
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
流式传输事件
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

Beta会话资源

添加会话资源
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
列出会话资源
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
获取会话资源
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
更新会话资源
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
删除会话资源
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta会话线程

列出会话线程
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
获取会话线程
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
归档会话线程
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta会话线程事件

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

Beta部署

创建部署
$ ant beta:deployments create
POST/v1/deployments
列出部署
$ ant beta:deployments list
GET/v1/deployments
获取部署
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
更新部署
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
归档部署
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
立即运行部署
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
暂停部署
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
取消暂停部署
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

Beta部署运行

列出部署运行
$ ant beta:deployment-runs list
GET/v1/deployment_runs
获取部署运行
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

Beta保管库

创建保管库
$ ant beta:vaults create
POST/v1/vaults
列出保管库
$ ant beta:vaults list
GET/v1/vaults
获取保管库
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
更新保管库
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
删除保管库
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
归档保管库
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

Beta保管库凭证

创建凭证
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
列出凭证
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
获取凭证
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
更新凭证
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
删除凭证
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
归档凭证
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
验证凭证
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

Beta记忆存储

创建记忆存储
$ ant beta:memory-stores create
POST/v1/memory_stores
列出记忆存储
$ ant beta:memory-stores list
GET/v1/memory_stores
检索记忆存储
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
更新记忆存储
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
删除记忆存储
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
归档记忆存储
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

Beta记忆存储记忆

创建记忆
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
列出记忆
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
检索记忆
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新记忆
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
删除记忆
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta记忆存储记忆版本

列出记忆版本
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
检索记忆版本
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
对记忆版本进行脱敏
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta文件

上传文件
$ ant beta:files upload
POST/v1/files
列出文件
$ ant beta:files list
GET/v1/files
下载文件
$ ant beta:files download
GET/v1/files/{file_id}/content
获取文件元数据
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
删除文件
$ ant beta:files delete
DELETE/v1/files/{file_id}

Beta技能

创建技能
$ ant beta:skills create
POST/v1/skills
列出技能
$ ant beta:skills list
GET/v1/skills
获取技能
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
删除技能
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

Beta技能版本

创建技能版本
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
列出技能版本
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
下载技能版本内容
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content
获取技能版本
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
删除技能版本
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

Beta用户配置文件

创建用户配置文件
$ ant beta:user-profiles create
POST/v1/user_profiles
列出用户配置文件
$ ant beta:user-profiles list
GET/v1/user_profiles
获取用户配置文件
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
更新用户配置文件
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
创建注册 URL
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

创建 Dream
$ ant beta:dreams create
POST/v1/dreams
列出 Dream
$ ant beta:dreams list
GET/v1/dreams
获取 Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
取消 Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
归档 Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

Beta隧道

创建隧道
$ ant beta:tunnels create
POST/v1/tunnels
获取隧道
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
列出隧道
$ ant beta:tunnels list
GET/v1/tunnels
归档隧道
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
显示隧道令牌
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
轮换隧道令牌
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

Beta隧道证书

创建隧道证书
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
获取隧道证书
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
列出隧道证书
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
归档隧道证书
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Beta组织

获取当前组织
$ ant beta:organization retrieve
GET/v1/organizations/me

Beta组织API 密钥

列出 API 密钥
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
获取 API 密钥
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
更新 API 密钥
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

Beta组织外部密钥

创建外部密钥
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
列出外部密钥
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
获取外部密钥
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
更新外部密钥
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
删除外部密钥
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
验证外部密钥
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

Beta组织联合颁发者

创建联合签发者
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
列出联合签发者
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
获取联合签发者
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
更新联合签发者
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
归档联合签发者
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Beta组织联合规则

创建联合规则
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
列出联合规则
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
获取联合规则
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
更新联合规则
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
归档联合规则
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Beta组织联合规则工作区

添加联合规则工作区
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
列出联合规则工作区
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
移除联合规则工作区
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Beta组织邀请

创建邀请
$ ant beta:organization:invites create
POST/v1/organizations/invites
列出邀请
$ ant beta:organization:invites list
GET/v1/organizations/invites
获取邀请
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
删除邀请
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Beta组织服务账户

创建服务账户
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
列出服务账户
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
获取服务账户
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
更新服务账户
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
归档服务账户
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

Beta组织服务账户工作区

将工作区添加到服务账户
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
列出服务账户的工作区
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
从服务账户移除工作区
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Beta组织用户

列出用户
$ ant beta:organization:users list
GET/v1/organizations/users
获取用户
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
更新用户
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
移除用户
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

Beta组织工作区

列出工作区
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
创建工作区
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
获取工作区
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta组织工作区速率限制

列出工作区速率限制
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Beta组织工作区成员

列出工作区成员
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta组织工作区服务账户

列出服务账户工作区成员
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
创建服务账户工作区成员
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
获取服务账户工作区成员
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
更新服务账户工作区成员
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
删除服务账户工作区成员
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Beta组织速率限制

列出组织速率限制
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

Beta组织合规设置

获取合规设置
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
更新合规设置
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings