Claude Platform Docs

To enable the Compliance API, see the setup guide.

Set up the Compliance API

Code Artifact バージョンコンテンツのダウンロード

GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}

Artifact の 1 つのバージョンのコンテンツを、Content-Length なしのチャンクでレスポンス本文としてストリーミングします。multi_file_format=zip を指定すると、複数のファイルを持つバージョンは、Claude Doc(artifact_type が claude_docs である Artifact)のものを除き、そのファイルの ZIP アーカイブとして返されます。

ヘッダー: Content-Type(ZIP アーカイブの場合は application/zip、それ以外の場合は保存されている MIME タイプ)、Content-Disposition: attachment; filename*=utf-8''<name>(RFC 5987)、Cache-Control: no-store, private、および利用可能な場合は Content-MD5(base64)。<name> は、コンテンツの内容にかかわらず、ZIP アーカイブの場合は {artifact_id}-{version_id}.zip、それ以外の場合は {artifact_id}-{version_id}.txt です。Content-MD5 は非圧縮で保存された単一ファイルにのみ付与されるため、ZIP アーカイブに付与されることはありません。存在する場合は、本文をこれと照合してください。

このダウンロードに固有のエラー:

  • 404: Artifact が存在しないか APIキーで読み取れない、またはバージョンが保持されなくなっています。新しいバージョンが公開されると古いバージョンは削除されるため、Artifact のバージョンを再度一覧表示してください。組織の顧客管理の暗号化キーを使用できない場合にもこのエラーが返されます。キーが再び使用可能になったら再試行してください。
  • 503: 現在コンテンツを提供できません。たとえば、アップロードがまだ進行中であるか、中断された場合です。バックオフを使用して再試行してください。
  • error.details.error_code が multi_file_unavailable の 422: バージョンに複数のファイルがあります。multi_file_format=zip を追加してください。複数のファイルを持つ Claude Doc のバージョンは、Doc を表示する Web ページのみを保持しているため、いずれの場合もこのエラーになります。Doc のテキストは GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip でダウンロードしてください。
  • file_set_unavailable の 422: リクエストで multi_file_format=zip が設定され、バージョンに複数のファイルがあり、そのうちの 1 つに API がエクスポートできないパスがあります。再試行しないでください。

ダウンロード開始後にエラーが発生すると、200 ステータスがすでに送信された状態で本文が途中で終了します。たとえば、圧縮して保存されたコンテンツが展開後に 16 MiB を超える場合に発生します。Content-MD5 のない単一ファイルの場合、唯一の兆候は最後のチャンクの前に転送が中断されることであるため、このように中断したダウンロードは失敗として扱ってください。

バージョンのファイルの ZIP アーカイブには、Artifact とバージョンにちなんで名付けられた 1 つのトップレベルフォルダーが含まれます。そのフォルダーには files/ フォルダーとインデックス files.json が含まれます。インデックスは最後に書き込まれるため、アーカイブを開けない場合やトップレベルフォルダーに files.json がない場合は、アーカイブが不完全であるとみなしてください。

files.json には次のフィールドがあります:

  • artifact_id: リクエストで指定された Artifact ID。
  • version_id: リクエストで指定されたバージョン ID。
  • title: アーカイブ内のバージョンのタイトル。タイトルが保持されていない場合はそのバージョンの ID。
  • created_at: バージョンが公開された日時(RFC 3339、UTC)。不明な場合は null。
  • files: files/ 配下の各ファイルに 1 つずつのエントリで、original_path(バージョン内でのファイルのパス)、exported_as(アーカイブ内でのパス)、sha256(小文字の 16 進数)、size_bytes(圧縮前)、mime_type を含みます。exported_as は、トップレベルフォルダー、files/、original_path の順に連結したものです。すべてのオペレーティングシステムで安全に保存または開くことができない名前は変更されます。アーカイブ内のファイルを見つけるには、original_path ではなく exported_as を使用してください。
  • omitted_files: アーカイブから除外されたファイルで、それぞれ original_path、sha256、size_bytes、mime_type を含みます。これには、バージョンが別の Artifact から使用しているファイルが含まれます。また、別の組織がその Artifact タイプを所有している場合に、Artifact の作成元となった Artifact タイプ(Artifact を表示するアプリなど)からコピーされたファイルも含まれます。

files と omitted_files を合わせて最大 4,096 個のファイルが一覧表示され、それらの size_bytes の合計は最大 1 GiB で、20 MiB を超えるファイルはありません。

Path parameters
artifact_id: string

The Artifact ID (tagged ID, e.g., cart_abc123)

version_id: string

Opaque version identifier from the Artifact's versions list

Query parameters
multi_file_format: optional string

Set to zip, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, files.json. A version with one file is returned as that file. A Claude Doc's version never comes back as a ZIP.

Headers
"anthropic-version": optional string

The version of the Claude API you want to use.

Read more about versioning and our version history here.

"x-api-key": optional string
Code Artifact バージョンコンテンツのダウンロード
cURL
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"