Claude Platform Docs

To enable the Compliance API, see the setup guide.

Set up the Compliance API

合規 API

合規 API活動

查詢合規活動
GET/v1/compliance/activities

列出已驗證租戶的合規活動。

合規 API組織

列出組織
GET/v1/compliance/organizations

列出父組織下的組織。

合規 API組織使用者

列出組織使用者
GET/v1/compliance/organizations/{org_uuid}/users

列出組織目前的使用者成員。

合規 API組織角色

列出合規角色
GET/v1/compliance/organizations/{org_uuid}/roles
取得合規角色
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}

合規 API組織角色權限

列出合規角色權限
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions

合規 API組織設定

取得有效的組織設定
GET/v1/compliance/organizations/{organization_id}/settings

擷取組織的有效設定。

合規 API群組

列出合規群組
GET/v1/compliance/groups
取得合規群組
GET/v1/compliance/groups/{group_id}

合規 API群組成員

列出合規群組成員
GET/v1/compliance/groups/{group_id}/members

合規 API應用程式對話

列出對話
GET/v1/compliance/apps/chats

列出聊天中繼資料，並提供篩選功能以進行針對性的合規審查。結果會依 order_by 鍵按時間順序（時間遞增）排序，時間相同時則依 id 排序。

刪除對話
DELETE/v1/compliance/apps/chats/{claude_chat_id}

永久刪除聊天及其所有相關訊息與檔案。這是無法復原的破壞性操作。

合規 API應用程式對話訊息

取得對話訊息
GET/v1/compliance/apps/chats/{claude_chat_id}/messages

擷取特定對話的訊息歷史記錄和檔案中繼資料。

合規 API應用程式對話檔案

取得檔案中繼資料
GET/v1/compliance/apps/chats/files/{claude_file_id}

擷取對話訊息中所參照檔案的中繼資料，而不下載檔案內容。請使用同層級的 /content 端點來下載位元組。

刪除檔案
DELETE/v1/compliance/apps/chats/files/{claude_file_id}

永久刪除特定檔案。這是無法復原的破壞性操作。

下載檔案內容
GET/v1/compliance/apps/chats/files/{claude_file_id}/content

下載對話訊息中所參照檔案的二進位內容。

合規 API應用程式對話生成的檔案

取得 Claude 生成的檔案中繼資料
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}

傳回助理透過工具使用所建立之檔案的中繼資料。

下載 Claude 生成的檔案
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content

下載助理透過工具使用所建立之檔案的二進位內容。

合規 API應用程式專案

列出專案
GET/v1/compliance/apps/projects

列出具有篩選功能的專案中繼資料。結果依 created_at 按時間順序（時間遞增）排序。

取得專案詳細資訊
GET/v1/compliance/apps/projects/{project_id}

取得特定專案的詳細資訊。

刪除專案
DELETE/v1/compliance/apps/projects/{project_id}

基於合規目的刪除專案。

合規 API應用程式專案附件

列出專案附件
GET/v1/compliance/apps/projects/{project_id}/attachments

列出附加至專案的檔案和文件。

合規 API應用程式專案協作者

列出專案協作者
GET/v1/compliance/apps/projects/{project_id}/collaborators

列出專案上的使用者、群組和組織範圍的授權。

合規 API應用程式專案文件

取得專案文件內容
GET/v1/compliance/apps/projects/documents/{document_id}

取得特定專案文件的詳細資訊。

取得專案文件中繼資料
GET/v1/compliance/apps/projects/documents/{document_id}/metadata

傳回專案文件的中繼資料，不含內容本文。

刪除專案文件
DELETE/v1/compliance/apps/projects/documents/{document_id}

基於合規目的刪除專案文件。

合規 API應用程式Artifacts

取得 Artifact 中繼資料
GET/v1/compliance/apps/artifacts/{artifact_version_id}

傳回 Artifact 版本的中繼資料，不含內容本文。

下載 Artifact 內容
GET/v1/compliance/apps/artifacts/{artifact_version_id}/content

基於合規目的下載 Artifact 版本的內容。

合規 API應用程式工作階段本機

列出本機工作階段
GET/v1/compliance/apps/sessions/local

列出金鑰可讀取之組織範圍內的本機工作階段。

擷取本機工作階段
GET/v1/compliance/apps/sessions/local/{local_session_id}

擷取單一本機工作階段。

合規 API應用程式工作階段本機訊息

擷取本機工作階段訊息
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages

讀取單一本機工作階段的對話記錄，預設由舊到新排序。

合規 API應用程式工作階段遠端

列出遠端工作階段
GET/v1/compliance/apps/sessions/remote

列出金鑰可讀取之組織範圍內的遠端工作階段（在 Anthropic 管理的雲端環境中執行的 Cowork 工作階段）。

合規 API應用程式工作階段遠端訊息

擷取遠端工作階段訊息
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages

擷取單一遠端工作階段的逐字稿：使用者提示、助理回應，以及工具呼叫和結果。不包含思考區塊和圖片。

合規 API應用程式程式碼Artifacts

列出 Code Artifacts
GET/v1/compliance/apps/code/artifacts

列出父組織下各組織所擁有的 Claude Code Artifacts。

下載 Code Artifact 版本內容
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}

以回應本文串流傳送 Claude Code Artifact 某一版本的內容。

下載 Code Artifact 內容
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content

以回應本文串流傳送 Artifact 的目前內容。對於 Claude Doc，內容為該 Doc 的文字，以 Word 檔案的 ZIP 封存檔形式提供，每個文字分頁一個檔案，且請求必須設定 multi_file_format=zip。對於其他任何 Artifact，內容為最新版本，與 GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id} 傳回的內容相同。

刪除 Code Artifact
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}

永久刪除 Code Artifact 及其所有版本。這是無法復原的破壞性操作。200 回應表示刪除已啟動且 Artifact 已被認領；內容移除會以非同步方式完成。