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
計算訊息中的 Token 數
$ 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