Claude Platform Docs

ベータ

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

ベータモデル

モデルの一覧
GET/v1/models
モデルを取得
GET/v1/models/{model_id}

ベータメッセージ

メッセージを作成
POST/v1/messages
メッセージ内のトークンをカウント
POST/v1/messages/count_tokens

ベータメッセージバッチ

メッセージバッチを作成
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

ベータエージェント

エージェントを取得
GET/v1/agents/{agent_id}
エージェントを更新
POST/v1/agents/{agent_id}
エージェントをアーカイブ
POST/v1/agents/{agent_id}/archive

ベータエージェントバージョン

エージェントバージョンの一覧
GET/v1/agents/{agent_id}/versions

ベータ環境

環境を作成
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

ベータ環境ワーク

ワークアイテムを取得
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

ベータセッションイベント

イベントの一覧
GET/v1/sessions/{session_id}/events
イベントを送信
POST/v1/sessions/{session_id}/events
イベントをストリーミング
GET/v1/sessions/{session_id}/events/stream

ベータセッションリソース

セッションリソースを追加
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}

ベータセッションスレッド

セッションスレッドの一覧
GET/v1/sessions/{session_id}/threads
セッションスレッドを取得
GET/v1/sessions/{session_id}/threads/{thread_id}
セッションスレッドをアーカイブ
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

ベータセッションスレッドイベント

セッションスレッドイベントの一覧
GET/v1/sessions/{session_id}/threads/{thread_id}/events
セッションスレッドイベントをストリーミング
GET/v1/sessions/{session_id}/threads/{thread_id}/stream
デプロイメントを作成
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/{deployment_run_id}

ベータVault

Vault を作成
POST/v1/vaults
Vault の一覧を取得
GET/v1/vaults
Vault を取得
GET/v1/vaults/{vault_id}
Vault を更新
POST/v1/vaults/{vault_id}
Vault を削除
DELETE/v1/vaults/{vault_id}
Vault をアーカイブ
POST/v1/vaults/{vault_id}/archive

ベータVault認証情報

認証情報を作成
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/{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

ベータメモリストアメモリ

メモリを作成
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}

ベータメモリストアメモリバージョン

メモリバージョンの一覧を取得
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

ベータファイル

ファイルの一覧
GET/v1/files
ファイルをダウンロード
GET/v1/files/{file_id}/content
ファイルを削除
DELETE/v1/files/{file_id}

ベータスキル

スキルを作成
POST/v1/skills
スキルの一覧
GET/v1/skills
スキルを取得
GET/v1/skills/{skill_id}
スキルを削除
DELETE/v1/skills/{skill_id}

ベータスキルバージョン

スキルバージョンを作成
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}

ベータWebhook

Unwrap
Function
Parse Unverified
Function
ユーザープロファイルを取得
GET/v1/user_profiles/{user_profile_id}
ユーザープロファイルを更新
POST/v1/user_profiles/{user_profile_id}
登録 URL を作成
POST/v1/user_profiles/{user_profile_id}/enrollment_url

ベータDream

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

ベータトンネル

トンネルを作成
POST/v1/tunnels
トンネルを取得
GET/v1/tunnels/{tunnel_id}
トンネルをアーカイブ
POST/v1/tunnels/{tunnel_id}/archive
トンネルトークンを表示
POST/v1/tunnels/{tunnel_id}/reveal_token
トンネルトークンをローテーション
POST/v1/tunnels/{tunnel_id}/rotate_token

ベータトンネル証明書

トンネル証明書を作成
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

ベータ組織

現在の組織を取得
GET/v1/organizations/me

ベータ組織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}

ベータ組織外部キー

外部キーを作成
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

ベータ組織フェデレーション発行者

フェデレーション発行者を作成
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

ベータ組織フェデレーションルール

フェデレーションルールを作成
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

ベータ組織フェデレーションルールワークスペース

フェデレーションルールのワークスペースを追加
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}

ベータ組織招待

招待を作成
POST/v1/organizations/invites
招待の一覧を取得
GET/v1/organizations/invites
招待を取得
GET/v1/organizations/invites/{invite_id}
招待を削除
DELETE/v1/organizations/invites/{invite_id}

ベータ組織サービスアカウント

サービスアカウントを作成
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

ベータ組織サービスアカウントワークスペース

サービスアカウントにワークスペースを追加
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}

ベータ組織ユーザー

ユーザーの一覧を取得
GET/v1/organizations/users
ユーザーを取得
GET/v1/organizations/users/{user_id}
ユーザーを更新
POST/v1/organizations/users/{user_id}
ユーザーを削除
DELETE/v1/organizations/users/{user_id}

ベータ組織ワークスペース

ワークスペースの一覧を取得
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

ベータ組織ワークスペースレート制限

ワークスペースのレート制限の一覧を取得
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

ベータ組織ワークスペースメンバー

ワークスペースメンバーの一覧を取得
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}

ベータ組織ワークスペースサービスアカウント

サービスアカウントのワークスペースメンバーの一覧を取得
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}

ベータ組織レート制限

組織のレート制限の一覧を取得
GET/v1/organizations/rate_limits

ベータ組織コンプライアンス設定

コンプライアンス設定を取得
GET/v1/organizations/compliance_settings
コンプライアンス設定を更新
POST/v1/organizations/compliance_settings