Claude Platform Docs

To enable the Compliance API, see the setup guide.

Set up the Compliance API

Unduh Konten Versi Artifact Kode

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

Mengalirkan konten satu versi Artifact sebagai isi respons, dalam potongan tanpa Content-Length. Dengan multi_file_format=zip, versi yang memiliki lebih dari satu file, selain versi Claude Doc (Artifact yang artifact_type-nya adalah claude_docs), dikembalikan sebagai arsip ZIP berisi file-filenya.

Header: Content-Type (application/zip untuk arsip ZIP, selain itu tipe MIME yang tersimpan), Content-Disposition: attachment; filename*=utf-8''<name> (RFC 5987), Cache-Control: no-store, private dan, jika tersedia, Content-MD5 (base64). <name> adalah {artifact_id}-{version_id}.zip untuk arsip ZIP, selain itu {artifact_id}-{version_id}.txt, apa pun kontennya. Content-MD5 hanya ada pada satu file yang disimpan tanpa kompresi, sehingga tidak pernah ada pada arsip ZIP. Periksa isi respons terhadapnya jika ada.

Error khusus untuk unduhan ini:

  • 404: Artifact tidak ada atau kunci API tidak dapat membacanya, atau versi tersebut tidak lagi disimpan. Versi lama dihapus saat versi baru dipublikasikan, jadi tampilkan kembali daftar versi Artifact. Anda juga mendapatkan error ini ketika kunci enkripsi yang dikelola pelanggan milik organisasi tidak dapat digunakan. Coba ulang setelah kunci dapat digunakan kembali.
  • 503: konten tidak dapat disajikan saat ini, misalnya karena unggahannya masih berlangsung atau telah ditinggalkan. Coba ulang dengan backoff.
  • 422 dengan error.details.error_code multi_file_unavailable: versi memiliki lebih dari satu file. Tambahkan multi_file_format=zip. Versi Claude Doc dengan lebih dari satu file tetap mendapatkan error ini, karena versi tersebut hanya berisi halaman web yang menampilkan Doc. Unduh teks Doc dengan GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip.
  • 422 dengan file_set_unavailable: permintaan mengatur multi_file_format=zip, versi memiliki lebih dari satu file, dan salah satunya memiliki path yang tidak dapat diekspor oleh API. Jangan mencoba ulang.

Error setelah unduhan dimulai akan menghentikan isi respons lebih awal, dengan status 200 yang sudah terkirim. Misalnya, hal ini terjadi pada konten yang disimpan terkompresi ketika ukurannya melebihi 16 MiB setelah didekompresi. Untuk satu file tanpa Content-MD5, satu-satunya tanda adalah transfer yang terhenti sebelum potongan terakhirnya, jadi anggap unduhan yang terhenti dengan cara ini sebagai gagal.

Arsip ZIP berisi file-file suatu versi memuat satu folder tingkat atas, yang dinamai sesuai Artifact dan versinya. Folder tersebut berisi folder files/ dan sebuah indeks, files.json. Indeks ditulis terakhir, jadi anggap arsip tidak lengkap jika tidak dapat dibuka atau tidak memiliki files.json di folder tingkat atasnya.

files.json memiliki field berikut:

  • artifact_id: ID Artifact, sesuai dengan permintaan.
  • version_id: ID versi, sesuai dengan permintaan.
  • title: judul versi dalam arsip, atau ID versi tersebut jika tidak ada judul yang disimpan.
  • created_at: waktu versi dipublikasikan (RFC 3339, UTC), atau null jika tidak diketahui.
  • files: satu entri untuk setiap file di bawah files/, dengan original_path (path file dalam versi), exported_as (path-nya dalam arsip), sha256 (hex huruf kecil), size_bytes (sebelum kompresi) dan mime_type. exported_as adalah folder tingkat atas, lalu files/, lalu original_path. Nama yang tidak dapat disimpan atau dibuka dengan aman di setiap sistem operasi akan diubah. Gunakan exported_as, bukan original_path, untuk menemukan file dalam arsip.
  • omitted_files: file yang tidak disertakan dalam arsip, masing-masing dengan original_path, sha256, size_bytes dan mime_type. File ini mencakup file yang digunakan versi dari Artifact lain. File ini juga mencakup file yang disalin dari tipe Artifact yang menjadi dasar pembuatan Artifact, seperti aplikasi yang menampilkannya, ketika organisasi lain memiliki tipe tersebut.

files dan omitted_files bersama-sama mencantumkan paling banyak 4.096 file, total size_bytes-nya paling banyak 1 GiB, dan tidak ada file yang melebihi 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
Unduh Konten Versi Artifact Kode
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"