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
計算訊息中的 Token 數
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
建立代理程式
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
建立工作階段
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