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 47 more
One of the following:
BetaAPIError object{ type: "api_error", message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
BetaAuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
BetaBillingError object{ type: "billing_error", message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
BetaCurrency = "USD"
One of the following:
BetaErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string or null
BetaGatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
BetaInvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
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{ type: "not_found_error", message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
BetaOverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
BetaPermissionError object{ type: "permission_error", message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
BetaRateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

ベータモデル

モデルの一覧
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}

このエンドポイントはべき等であり、メッセージバッチの完了をポーリングするために使用できます。メッセージバッチの結果にアクセスするには、レスポンス内のresults_urlフィールドに対してリクエストを行ってください。

メッセージバッチの一覧
GET/v1/messages/batches

ワークスペース内のすべてのメッセージバッチを一覧表示します。最も新しく作成されたバッチが最初に返されます。

メッセージバッチをキャンセル
POST/v1/messages/batches/{message_batch_id}/cancel

バッチは処理が終了する前であればいつでもキャンセルできます。キャンセルが開始されると、バッチはcanceling状態になり、この間にシステムはキャンセルを確定する前に、進行中の中断不可能なリクエストを完了させる場合があります。

メッセージバッチを削除
DELETE/v1/messages/batches/{message_batch_id}

メッセージバッチを削除します。

メッセージバッチの結果を取得
GET/v1/messages/batches/{message_batch_id}/results

メッセージバッチの結果を.jsonlファイルとしてストリーミングします。

ベータエージェント

エージェントを取得
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}

IDで特定の環境を取得します。

環境を更新
POST/v1/environments/{environment_id}

既存の環境の構成を更新します。

環境を削除
DELETE/v1/environments/{environment_id}

IDで環境を削除します。削除の確認を返します。

環境をアーカイブ
POST/v1/environments/{environment_id}/archive

IDで環境をアーカイブします。アーカイブされた環境は新しいセッションの作成に使用できません。

ベータ環境ワーク

ワークアイテムを取得
GET/v1/environments/{environment_id}/work/{work_id}

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ワークをポーリング
GET/v1/environments/{environment_id}/work/poll

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ワークを確認応答
POST/v1/environments/{environment_id}/work/{work_id}/ack

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ハートビートを記録
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ワークを停止
POST/v1/environments/{environment_id}/work/{work_id}/stop

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ワークアイテムの一覧
GET/v1/environments/{environment_id}/work

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

ワークアイテムを更新
POST/v1/environments/{environment_id}/work/{work_id}

注: これらのエンドポイントは、セルフホスト型サンドボックス環境でセッションをオーケストレーションするために、SDKおよびCLIで提供される事前構築済みの環境ワーカーによって自動的に呼び出されます。参考としてここに記載していますが、直接呼び出す必要はありません。

キューの統計を取得
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

スキルバージョンのコンテンツを zip アーカイブとしてダウンロードします。

スキルバージョンを取得
GET/v1/skills/{skill_id}/versions/{version}
スキルバージョンを削除
DELETE/v1/skills/{skill_id}/versions/{version}
ユーザープロファイルを取得
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}

IDを指定してドリームを取得し、そのステータス、出力メモリストア、トークン使用量を確認します。

Dream をキャンセル
POST/v1/dreams/{dream_id}/cancel

pending または running のドリームを停止します。

Dream をアーカイブ
POST/v1/dreams/{dream_id}/archive

completed、failed、または canceled のドリームを、デフォルトのドリーム一覧から非表示にします。

ベータトンネル

トンネルを作成
POST/v1/tunnels

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネルを取得
GET/v1/tunnels/{tunnel_id}

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネルの一覧を取得
GET/v1/tunnels

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネルをアーカイブ
POST/v1/tunnels/{tunnel_id}/archive

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネルトークンを表示
POST/v1/tunnels/{tunnel_id}/reveal_token

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネルトークンをローテーション
POST/v1/tunnels/{tunnel_id}/rotate_token

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

ベータトンネル証明書

トンネル証明書を作成
POST/v1/tunnels/{tunnel_id}/certificates

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネル証明書を取得
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネル証明書の一覧を取得
GET/v1/tunnels/{tunnel_id}/certificates

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

トンネル証明書をアーカイブ
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Tunnels API はリサーチプレビュー段階です。anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーが必要であり、非推奨期間を設けずに変更される可能性があります。この API は /v1/organizations/tunnels の Admin API エンドポイントに代わるものですが、移行期間中は従来のエンドポイントも引き続き利用できます。

ベータ組織

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

認証済みのAPIキーに関連付けられた組織の情報を取得します。

ベータ組織APIキー

APIキーの一覧を取得
GET/v1/organizations/api_keys
APIキーを取得(Admin API)
GET/v1/organizations/api_keys/{api_key_id}

組織内の単一のAPIキーに関する情報を、IDを指定して取得します。このAdmin APIエンドポイントにはAdmin APIキーが必要で、プログラムによるキー管理を目的としており、キーのシークレット値を返すことはありません。自分のAPIキーを表示または作成するには、Claude ConsoleのAPIキーにアクセスしてください。

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}

呼び出し元の組織内の単一の外部キー設定を、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

外部キー設定を顧客の KMS に対して検証します。

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

フェデレーション発行者を作成
POST/v1/organizations/federation_issuers

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者の一覧を取得
GET/v1/organizations/federation_issuers

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者を取得
GET/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者を更新
POST/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者をアーカイブ
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

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

フェデレーションルールを作成
POST/v1/organizations/federation_rules

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールの一覧を取得
GET/v1/organizations/federation_rules

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールを取得
GET/v1/organizations/federation_rules/{federation_rule_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールを更新
POST/v1/organizations/federation_rules/{federation_rule_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールをアーカイブ
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

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

フェデレーションルールのワークスペースを追加
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールのワークスペースの一覧を取得
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールのワークスペースを削除
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

ベータ組織招待

招待を作成
POST/v1/organizations/invites

メールでユーザーを組織に招待します。

招待の一覧を取得
GET/v1/organizations/invites

組織の招待を一覧表示します。

招待を取得
GET/v1/organizations/invites/{invite_id}

ID で招待を取得します。

招待を削除
DELETE/v1/organizations/invites/{invite_id}

保留中の招待を削除します。

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

サービスアカウントを作成
POST/v1/organizations/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントの一覧を取得
GET/v1/organizations/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントを取得
GET/v1/organizations/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントを更新
POST/v1/organizations/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントをアーカイブ
POST/v1/organizations/service_accounts/{service_account_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

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

サービスアカウントにワークスペースを追加
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースの一覧を取得
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントからワークスペースを削除
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

ベータ組織ユーザー

ユーザーの一覧を取得
GET/v1/organizations/users

組織のメンバーを一覧表示します。

ユーザーを取得
GET/v1/organizations/users/{user_id}

ユーザー 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

ワークスペースの rate limit(レート制限)を一覧表示します。

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

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

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを作成
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを取得
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを更新
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを削除
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

ベータ組織レート制限

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

List Messages API rate limits for your organization.

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

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

組織のコンプライアンス設定を取得します。

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

組織のコンプライアンス設定を更新します。

ベータ組織使用量レポート

Messages使用量レポートを取得
GET/v1/organizations/usage_report/messages
Claude Code使用量レポートを取得
GET/v1/organizations/usage_report/claude_code

Claude Codeユーザーの日次集計使用量メトリクスを取得します。 組織が開発者の生産性を分析し、カスタムダッシュボードを構築できるようにします。

ベータ組織コストレポート

コストレポートを取得
GET/v1/organizations/cost_report

ベータ組織MCPトンネル

トンネルの一覧を取得
Deprecated
GET/v1/organizations/tunnels

非推奨。 このAdmin APIエンドポイントは Claude API の /v1/tunnels に置き換えられ、移行期間後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネルを取得
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

非推奨。 このAdmin APIエンドポイントはClaude APIの /v1/tunnels に置き換えられており、移行期間の後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネルをアーカイブ
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

非推奨。 このAdmin APIエンドポイントはClaude APIの /v1/tunnels に置き換えられており、移行期間の後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネルトークンを表示
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

非推奨。 このAdmin APIエンドポイントは Claude API の /v1/tunnels に置き換えられ、移行期間後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネルトークンをローテーション
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

非推奨。 このAdmin APIエンドポイントは Claude API の /v1/tunnels に置き換えられ、移行期間後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

ベータ組織MCPトンネルトンネル証明書

トンネル証明書を作成
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

非推奨。 このAdmin APIエンドポイントはClaude APIの /v1/tunnels に置き換えられており、移行期間の後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネル証明書の一覧を取得
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

非推奨。 このAdmin APIエンドポイントは Claude API の /v1/tunnels に置き換えられ、移行期間後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネル証明書を取得
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

非推奨。 このAdmin APIエンドポイントはClaude APIの /v1/tunnels に置き換えられており、移行期間の後に削除されます。新しいインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を使用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

トンネル証明書をアーカイブ
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

非推奨。 このAdmin APIエンドポイントは、Claude APIの /v1/tunnels に置き換えられており、移行期間の終了後に削除されます。新規のインテグレーションでは、anthropic-beta: mcp-tunnels-2026-06-22 ヘッダーと workspace:manage_tunnels スコープを持つWIFトークンを使用して /v1/tunnels を利用してください。既存のインテグレーションは、移行期間中は mcp-tunnels-2026-05-19 ヘッダーと org:manage_tunnels スコープで引き続き動作します。

ベータ組織アナリティクスSummaries

アクティビティサマリーを取得
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

ベータ組織アナリティクスユーザー

ユーザーアクティビティの一覧を取得
GET/v1/organizations/analytics/users

指定した日のユーザーごとのアクティビティを、カーソルベースのページネーションで取得します。

ベータ組織アナリティクスアプリChatプロジェクト

チャットプロジェクト使用量を取得
GET/v1/organizations/analytics/apps/chat/projects

指定した日のプロジェクトごとのアクティビティを、カーソルベースのページネーションで取得します。

ベータ組織アナリティクスコネクター

コネクター使用量を取得
GET/v1/organizations/analytics/connectors

指定した日のコネクターごとの使用状況を、カーソルベースのページネーションで取得します。

ベータ組織アナリティクスプラグイン

プラグイン使用量を取得
GET/v1/organizations/analytics/plugins

指定した日のプラグインごとのインストールおよび呼び出しの使用状況を、ページネーション付きで取得します。

ベータ組織アナリティクススキル

スキル使用量を取得
GET/v1/organizations/analytics/skills

指定した日のスキルごとの使用状況を、カーソルベースのページネーションで取得します。

ベータ組織アナリティクスArtifacts

Artifactsのアクティビティを取得
GET/v1/organizations/analytics/artifacts

指定した日のアーティファクト作成アクティビティを、MIMEタイプごとに分類して取得します。

ベータ組織アナリティクス使用量レポート

トークン使用量の推移を取得
GET/v1/organizations/analytics/usage_report

指定した日付範囲におけるトークン使用量の推移を取得します。

ベータ組織アナリティクスUser Usage Report

ユーザーごとのトークン使用量を取得
GET/v1/organizations/analytics/user_usage_report

指定した日付範囲におけるユーザーごとのトークン使用量を取得します。

ベータ組織アナリティクスコストレポート

コストの推移を取得
GET/v1/organizations/analytics/cost_report

指定した日付範囲におけるUSD建てコストの推移を取得します。

ベータ組織アナリティクスUser Cost Report

ユーザーごとのコストを取得
GET/v1/organizations/analytics/user_cost_report

指定した日付範囲におけるユーザーごとのUSD建てコストを取得します。

ベータ組織支出上限

支出上限を設定
POST/v1/organizations/spend_limits

支出上限を設定します。

支出上限を取得
GET/v1/organizations/spend_limits/{spend_limit_id}

IDを指定して支出上限を取得します。

支出上限を削除
DELETE/v1/organizations/spend_limits/{spend_limit_id}

支出上限を削除します。

List Spend Limits
GET/v1/organizations/spend_limits

List the organization's spend limits.

ベータ組織支出上限Effective

有効な支出上限の一覧を取得
GET/v1/organizations/spend_limits/effective

各メンバーの有効な支出上限と期間累計の支出額の一覧を取得します。

ベータ組織支出上限引き上げリクエスト

支出上限引き上げリクエストの一覧を取得
GET/v1/organizations/spend_limit_increase_requests

支出上限引き上げリクエストの一覧を、新しい順に取得します。

支出上限引き上げリクエストを取得
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

支出上限引き上げリクエストを取得します。

支出上限引き上げリクエストを承認
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

保留中の支出上限引き上げリクエストを承認します。

支出上限引き上げリクエストを拒否
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

保留中の支出上限引き上げリクエストを拒否します。

ベータ組織RBACグループ

RBACグループを作成
POST/v1/organizations/rbac_groups

Claude Enterprise テナント内にRBACグループを作成します。API経由で作成されたグループのソースタイプは "direct" になります。

RBACグループの一覧を取得
GET/v1/organizations/rbac_groups

Claude Enterprise テナント内のRBACグループを一覧表示します。

RBACグループを取得
GET/v1/organizations/rbac_groups/{rbac_group_id}

IDでRBACグループを取得します。

RBACグループを更新
POST/v1/organizations/rbac_groups/{rbac_group_id}

RBACグループの名前を更新します。テナント内の組織がSCIMプロビジョニングを使用している間は、IDプロバイダーによってプロビジョニングされたグループ(ソースタイプ "scim")をAPIで変更することはできません。

RBACグループを削除
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

RBACグループを削除します。テナント内の組織がSCIMプロビジョニングを使用している間は、IDプロバイダーによってプロビジョニングされたグループ(ソースタイプ "scim")をAPIで削除することはできません。

ベータ組織RBACグループメンバー

RBACグループメンバーの一覧を取得
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

RBACグループのメンバーを一覧表示します。

RBACグループメンバーを追加
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

RBACグループにユーザーを追加します。テナント内の組織がSCIMプロビジョニングを使用している間は、IDプロバイダーによってプロビジョニングされたグループ(ソースタイプ "scim")のメンバーシップをAPIで変更することはできません。

RBACグループメンバーを削除
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

RBACグループからユーザーを削除します。テナント内の組織がSCIMプロビジョニングを使用している間は、IDプロバイダーによってプロビジョニングされたグループ(ソースタイプ "scim")のメンバーシップをAPIで変更することはできません。

ベータ組織RBACロール

RBACロールの一覧を取得
GET/v1/organizations/rbac_roles

組織内のRBACロールを一覧表示します。

RBACロールを取得
GET/v1/organizations/rbac_roles/{rbac_role_id}

IDでRBACロールを取得します。

ベータ組織RBACロール権限

RBACロールの権限の一覧を取得
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

RBACロールが付与する権限を一覧表示します。

ベータ組織プラグイン

Create Plugin
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

ベータ組織プラグインバージョン

Create Plugin Version
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

ベータ組織プラグインInstallation Settings

List Plugin Installation Settings
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

ベータ組織プラグインShares

List Plugin Shares
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

ベータ組織Plugin Marketplaces

List Plugin Marketplaces
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.