Cookie settings

We use cookies to deliver and improve our services, analyze site usage, and if you agree, to customize or personalize your experience and market our services to you. You can read our Cookie Policy here.

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

列出代码 Artifacts
GET/v1/compliance/apps/code/artifacts

列出父组织下各组织拥有的 Claude Code Artifacts。

下载代码 Artifact 版本内容
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}

以响应正文的形式流式传输 Claude Code Artifact 某个版本的内容。

删除代码 Artifact
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}

永久删除代码 Artifact 及其所有版本。这是一个破坏性操作，无法撤销。200 响应表示删除已启动且该 Artifact 已被认领；内容移除将异步完成。