Apps

Chats

列出聊天记录

get /v1/compliance/apps/chats

列出聊天元数据，支持过滤功能以便进行针对性的合规审查。结果按 created_at 时间顺序（升序）排列，相同时间按 id 排序。

查询参数

user_ids: array of string

按特定用户创建的聊天进行过滤。必填；每次请求传入 1-10 个用户 ID。可通过 GET /v1/compliance/organizations/{org_uuid}/users 枚举 ID。
after_id: optional string

分页游标，用于获取下一页结果（向时间更早的方向翻页）。要翻页时，请传入最近一次响应中的 last_id 值。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
before_id: optional string

分页游标，用于获取上一页结果（向时间更晚的方向翻页）。要翻页时，请传入最近一次响应中的 first_id 值。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
created_at: optional object { gt, gte, lt, lte }
- gt: optional string
  
  过滤在此时间之后创建的聊天（RFC 3339 格式）
- gte: optional string
  
  过滤在此时间或之后创建的聊天（RFC 3339 格式）
- lt: optional string
  
  过滤在此时间之前创建的聊天（RFC 3339 格式）
- lte: optional string
  
  过滤在此时间或之前创建的聊天（RFC 3339 格式）
limit: optional number

最大结果数（默认：100，最大：1000）
organization_ids: optional array of string

按组织 ID 过滤（接受 org_... 或组织 UUID）。可通过 GET /v1/compliance/organizations 枚举 ID。
project_ids: optional array of string

按项目 ID 过滤（接受 claude_proj_...）。可通过 GET /v1/compliance/apps/projects 枚举 ID。
updated_at: optional object { gt, gte, lt, lte }
- gt: optional string
  
  过滤在此时间之后更新的聊天（RFC 3339 格式）
- gte: optional string
  
  过滤在此时间或之后更新的聊天（RFC 3339 格式）
- lt: optional string
  
  过滤在此时间之前更新的聊天（RFC 3339 格式）
- lte: optional string
  
  过滤在此时间或之前更新的聊天（RFC 3339 格式）

请求头参数

"x-api-key": optional string

返回值

data: array of object { id, created_at, deleted_at, 8 more }

按 created_at 时间顺序排列的聊天元数据列表，相同时间按 id 排序
- id: string
  
  聊天 ID
- created_at: string
  
  创建时间戳
- deleted_at: string
  
  如果已删除，则为删除时间戳
- href: string
  
  在 claude.ai 中查看此聊天的 URL
- model: string
  
  此聊天选择的模型（例如 'claude-opus-4-7'）。对于从未记录过模型的旧版聊天，可能为 null。
- name: string
  
  聊天名称/标题
- organization_id: string
  
  此聊天所属的组织 ID
- organization_uuid: string
  
  此聊天所属的组织 UUID
- project_id: string
  
  此聊天所属的项目 ID
- updated_at: string
  
  最后更新时间戳
- user: object { id, email_address }
  
  聊天创建者的用户信息
  - id: string
    
    用户标识符
  - email_address: string
    
    用户的电子邮件地址
first_id: string

当前结果集中的第一个聊天 ID。要获取上一页，请在下一次请求中将其用作 before_id
has_more: boolean

当前结果集之外是否还有更多记录
last_id: string

当前结果集中的最后一个聊天 ID。要获取下一页，请在下一次请求中将其用作 after_id

示例

curl https://api.anthropic.com/v1/compliance/apps/chats \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "data": [
    {
      "id": "claude_chat_abc123",
      "name": "Product Requirements Discussion",
      "created_at": "2025-06-07T08:09:10Z",
      "updated_at": "2025-06-07T09:10:11Z",
      "organization_id": "org_abc123",
      "organization_uuid": "abcdef0123-4567-89ab-cdef-0123456789ab",
      "project_id": "claude_proj_xyz789",
      "model": "claude-opus-4-7",
      "user": {
        "id": "user_xyz456",
        "email_address": "user@example.com"
      },
      "href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789"
    }
  ],
  "has_more": false,
  "first_id": "claude_chat_abc123",
  "last_id": "claude_chat_abc123"
}

删除聊天

delete /v1/compliance/apps/chats/{claude_chat_id}

永久删除聊天及其所有关联消息和文件。此操作为破坏性操作，无法撤销。

路径参数

claude_chat_id: string

聊天 ID（带标签的 ID，例如 claude_chat_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

已删除的 Claude 聊天的 ID
type: optional "claude_chat_deleted"

确认删除的常量字符串
- "claude_chat_deleted"

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "claude_chat_abc123",
  "type": "claude_chat_deleted"
}

领域类型

Chat List Response

ChatListResponse object { id, created_at, deleted_at, 8 more }

用于列出聊天的聊天元数据（不含消息）。
- id: string
  
  聊天 ID
- created_at: string
  
  创建时间戳
- deleted_at: string
  
  如果已删除，则为删除时间戳
- href: string
  
  在 claude.ai 中查看此聊天的 URL
- model: string
  
  此聊天选择的模型（例如 'claude-opus-4-7'）。对于从未记录过模型的旧版聊天，可能为 null。
- name: string
  
  聊天名称/标题
- organization_id: string
  
  此聊天所属的组织 ID
- organization_uuid: string
  
  此聊天所属的组织 UUID
- project_id: string
  
  此聊天所属的项目 ID
- updated_at: string
  
  最后更新时间戳
- user: object { id, email_address }
  
  聊天创建者的用户信息
  - id: string
    
    用户标识符
  - email_address: string
    
    用户的电子邮件地址

Chat Delete Response

ChatDeleteResponse object { id, type }

删除 Claude 聊天的响应。
- id: string
  
  已删除的 Claude 聊天的 ID
- type: optional "claude_chat_deleted"
  
  确认删除的常量字符串
  - "claude_chat_deleted"

Messages

获取聊天消息

get /v1/compliance/apps/chats/{claude_chat_id}/messages

获取特定聊天的消息历史和文件元数据。

路径参数

claude_chat_id: string

聊天 ID（带标签的 ID，例如 claude_chat_abc123）

查询参数

after_id: optional string

分页游标，用于获取下一页结果（向时间更早的方向翻页）。要翻页时，请传入最近一次响应中的 last_id 值。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
before_id: optional string

分页游标，用于获取上一页结果（向时间更晚的方向翻页）。要翻页时，请传入最近一次响应中的 first_id 值。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
created_at: optional object { gt, gte, lt, lte }
- gt: optional string
  
  过滤在此时间之后创建的消息（RFC 3339 格式）
- gte: optional string
  
  过滤在此时间或之后创建的消息（RFC 3339 格式）
- lt: optional string
  
  过滤在此时间之前创建的消息（RFC 3339 格式）
- lte: optional string
  
  过滤在此时间或之前创建的消息（RFC 3339 格式）
limit: optional number

最大结果数（最大：1000）。省略时，完整结果集将在一个响应中返回。
order: optional "asc" or "desc"

响应中消息的排序方向。asc（默认）返回最旧的在前；desc 返回最新的在前。
- "asc"
- "desc"
updated_at: optional object { gt, gte, lt, lte }
- gt: optional string
  
  过滤在此时间之后更新的消息（RFC 3339 格式）
- gte: optional string
  
  过滤在此时间或之后更新的消息（RFC 3339 格式）
- lt: optional string
  
  过滤在此时间之前更新的消息（RFC 3339 格式）
- lte: optional string
  
  过滤在此时间或之前更新的消息（RFC 3339 格式）

请求头参数

"x-api-key": optional string

返回值

id: string

聊天 ID
chat_messages: array of object { id, artifacts, content, 4 more }

按 created_at 顺序排列的聊天消息数组
- id: string
  
  消息的唯一标识符，例如 'claude_chat_msg_abcd1234'
- artifacts: array of object { id, artifact_type, title, version_id }
  
  助手在此消息中生成或更新的版本化文档。通过 GET /v1/compliance/apps/artifacts/{artifact_version_id}/content 下载。
  - id: string
    
    制品 ID，例如 'claude_artifact_abc123'
  - artifact_type: string
    
    类似 MIME 的制品类型，例如 'application/vnd.ant.code'
  - title: string
    
    制品标题
  - version_id: string
    
    制品版本 ID，例如 'claude_artifact_version_abc123'
- content: array of object { text, type }
  
  消息中的内容块
  - text: string
    
    来自用户或助手的文本内容
  - type: "text"
    - "text"
- created_at: string
  
  消息创建时间戳 - 对于用户：发送消息的时间；对于助手：完成最后一个内容块的时间
- files: array of object { id, filename, mime_type }
  
  用户上传的二进制文件附件。通过 GET /v1/compliance/apps/chats/files/{claude_file_id}/content 下载。
  - id: string
    
    文件 ID
  - filename: string
    
    文件的显示名称
  - mime_type: string
    
    文件上传时的 MIME 类型（例如 'application/pdf'）
- generated_files: array of object { id, filename, mime_type }
  
  助手通过工具使用创建的可下载文件（例如 PDF、电子表格、演示文稿）。与 files 不同，后者是附加到消息的上传文件。通过 GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content 下载。
  - id: string
    
    不透明的生成文件 ID，例如 'claude_gen_file_abc123'。请将其视为不透明字符串；编码可能会在不另行通知的情况下更改。
  - filename: string
    
    生成文件的显示名称
  - mime_type: string
    
    生成文件的工具报告的 MIME 类型
- role: "assistant" or "user"
  
  消息发送者（用户或助手）
  - "assistant"
  - "user"
created_at: string

创建时间戳
deleted_at: string

如果已删除，则为删除时间戳
first_id: string

当前结果集中第一条消息的不透明分页游标。在下一次请求中作为 before_id 传入以向后翻页。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
has_more: boolean

当前结果集之外是否还有更多聊天消息。在后续请求中使用 last_id 作为 after_id 以向前翻页。
href: string

在 claude.ai 中查看此聊天的 URL
last_id: string

当前结果集中最后一条消息的不透明分页游标。在下一次请求中作为 after_id 传入以向前翻页。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
model: string

此聊天选择的模型（例如 'claude-opus-4-7'）。对于从未记录过模型的旧版聊天，可能为 null。
name: string

聊天名称
organization_id: string

此聊天所属的组织 ID
organization_uuid: string

此聊天所属的组织 UUID
project_id: string

此聊天所属的项目 ID
updated_at: string

最后更新时间戳
user: object { id, email_address }

用户信息
- id: string
  
  用户标识符
- email_address: string
  
  用户的电子邮件地址

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID/messages \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "claude_chat_abc123",
  "name": "Product Requirements Discussion",
  "created_at": "2025-06-07T08:09:10Z",
  "updated_at": "2025-06-07T08:09:11Z",
  "organization_id": "org_abc123",
  "organization_uuid": "abcdef0123-4567-89ab-cdef-0123456789ab",
  "project_id": "claude_proj_xyz789",
  "model": "claude-opus-4-7",
  "user": {
    "id": "user_xyz456",
    "email_address": "user@example.com"
  },
  "href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789",
  "chat_messages": [
    {
      "id": "claude_chat_msg_abc123",
      "role": "user",
      "created_at": "2025-06-07T08:09:10Z",
      "content": [
        {
          "type": "text",
          "text": "Can you help me draft requirements for our new dashboard feature?"
        }
      ],
      "files": [
        {
          "id": "claude_file_xyz789",
          "filename": "dashboard_mockup_v1.pdf",
          "mime_type": "application/pdf"
        }
      ]
    },
    {
      "id": "claude_chat_msg_def456",
      "role": "assistant",
      "created_at": "2025-06-07T08:09:11Z",
      "content": [
        {
          "type": "text",
          "text": "I'd be happy to help you draft requirements for your dashboard feature..."
        }
      ],
      "artifacts": [
        {
          "id": "claude_artifact_abc123",
          "version_id": "claude_artifact_version_xyz789",
          "title": "Dashboard Requirements Draft",
          "artifact_type": "text/markdown"
        }
      ]
    }
  ],
  "has_more": false,
  "first_id": "eyJtc2dfdXVpZCI6ICIwZjcwYjA2Ni0uLi4ifQ==",
  "last_id": "eyJtc2dfdXVpZCI6ICJhNGUwYjE3Mi0uLi4ifQ=="
}

领域类型

Message List Response

MessageListResponse object { id, artifacts, content, 4 more }

聊天对话中的单条消息。
- id: string
  
  消息的唯一标识符，例如 'claude_chat_msg_abcd1234'
- artifacts: array of object { id, artifact_type, title, version_id }
  
  助手在此消息中生成或更新的版本化文档。通过 GET /v1/compliance/apps/artifacts/{artifact_version_id}/content 下载。
  - id: string
    
    制品 ID，例如 'claude_artifact_abc123'
  - artifact_type: string
    
    类似 MIME 的制品类型，例如 'application/vnd.ant.code'
  - title: string
    
    制品标题
  - version_id: string
    
    制品版本 ID，例如 'claude_artifact_version_abc123'
- content: array of object { text, type }
  
  消息中的内容块
  - text: string
    
    来自用户或助手的文本内容
  - type: "text"
    - "text"
- created_at: string
  
  消息创建时间戳 - 对于用户：发送消息的时间；对于助手：完成最后一个内容块的时间
- files: array of object { id, filename, mime_type }
  
  用户上传的二进制文件附件。通过 GET /v1/compliance/apps/chats/files/{claude_file_id}/content 下载。
  - id: string
    
    文件 ID
  - filename: string
    
    文件的显示名称
  - mime_type: string
    
    文件上传时的 MIME 类型（例如 'application/pdf'）
- generated_files: array of object { id, filename, mime_type }
  
  助手通过工具使用创建的可下载文件（例如 PDF、电子表格、演示文稿）。与 files 不同，后者是附加到消息的上传文件。通过 GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content 下载。
  - id: string
    
    不透明的生成文件 ID，例如 'claude_gen_file_abc123'。请将其视为不透明字符串；编码可能会在不另行通知的情况下更改。
  - filename: string
    
    生成文件的显示名称
  - mime_type: string
    
    生成文件的工具报告的 MIME 类型
- role: "assistant" or "user"
  
  消息发送者（用户或助手）
  - "assistant"
  - "user"

Files

获取文件元数据

get /v1/compliance/apps/chats/files/{claude_file_id}

获取聊天消息中引用的文件的元数据，但不下载文件内容。使用同级 /content 端点下载文件字节。

路径参数

claude_file_id: string

文件 ID（带标签的 ID，例如 claude_file_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

文件 ID
created_at: string

文件创建时间戳
filename: string

文件的显示名称（如已设置）
md5: string

文件首选可下载变体的小写十六进制 MD5，上传时记录。如果没有可用的存储哈希值，则为 null。同级 /content 端点还会设置一个 Content-MD5 请求头（按 RFC 1864 进行 base64 编码），基于实际提供的字节计算；当两者不一致时，以请求头为准。
message_ids: array of string

此文件附加到的聊天消息 ID。一个文件可以被多条消息引用。
mime_type: string

文件首选可下载变体的 MIME 类型（例如 'application/pdf'）。对于没有可下载内容的文件（例如代码解释器输出），可能为 null。
size_bytes: number

文件首选可下载变体的字节大小（如已知）

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "claude_file_xyz789",
  "filename": "quarterly_report.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 1048576,
  "md5": "5d41402abc4b2a76b9719d911017c592",
  "created_at": "2024-01-15T10:30:00Z",
  "message_ids": [
    "claude_chat_msg_abc123"
  ]
}

删除文件

delete /v1/compliance/apps/chats/files/{claude_file_id}

永久删除特定文件。此操作为破坏性操作，无法撤销。

路径参数

claude_file_id: string

文件 ID（带标签的 ID，例如 claude_file_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

已删除文件的 ID
type: optional "claude_file_deleted"

确认删除的常量字符串
- "claude_file_deleted"

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "claude_file_xyz789",
  "type": "claude_file_deleted"
}

下载文件内容

get /v1/compliance/apps/chats/files/{claude_file_id}/content

下载聊天消息中引用的文件的二进制内容。

路径参数

claude_file_id: string

文件 ID（带标签的 ID，例如 claude_file_abc123）

请求头参数

"x-api-key": optional string

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID/content \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

领域类型

File Retrieve Response

FileRetrieveResponse object { id, created_at, filename, 4 more }

GET /v1/compliance/apps/chats/files/{claude_file_id} 的文件元数据。

仅返回元数据。使用同级 /content 端点下载文件字节。
- id: string
  
  文件 ID
- created_at: string
  
  文件创建时间戳
- filename: string
  
  文件的显示名称（如已设置）
- md5: string
  
  文件首选可下载变体的小写十六进制 MD5，上传时记录。如果没有可用的存储哈希值，则为 null。同级 /content 端点还会设置一个 Content-MD5 请求头（按 RFC 1864 进行 base64 编码），基于实际提供的字节计算；当两者不一致时，以请求头为准。
- message_ids: array of string
  
  此文件附加到的聊天消息 ID。一个文件可以被多条消息引用。
- mime_type: string
  
  文件首选可下载变体的 MIME 类型（例如 'application/pdf'）。对于没有可下载内容的文件（例如代码解释器输出），可能为 null。
- size_bytes: number
  
  文件首选可下载变体的字节大小（如已知）

File Delete Response

FileDeleteResponse object { id, type }

删除合规文件的响应。
- id: string
  
  已删除文件的 ID
- type: optional "claude_file_deleted"
  
  确认删除的常量字符串
  - "claude_file_deleted"

Generated Files

获取 Claude 生成的文件元数据

get /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}

返回助手通过工具使用创建的文件的元数据。

元数据从 Filestore（每个对话工具输出的持久后备存储）读取。使用同级 /content 端点下载文件字节。

路径参数

claude_gen_file_id: string

生成文件 ID（例如 'claude_gen_file_abc123'），在 GET /apps/chats/{claude_chat_id}/messages 的 chat_messages[].generated_files[].id 中返回。

请求头参数

"x-api-key": optional string

返回值

id: string

不透明的生成文件 ID，例如 'claude_gen_file_abc123'。
claude_chat_id: string

此生成文件所属的聊天
created_at: string

来自 Filestore 的文件创建时间戳
filename: string

生成文件的显示名称
md5: string

存储文件的小写十六进制 MD5，由 Filestore 记录。如果没有可用的存储哈希值，则为 null。同级 /content 端点还会设置一个 Content-MD5 请求头（按 RFC 1864 进行 base64 编码），基于实际提供的字节计算。
mime_type: string

Filestore 记录的 MIME 类型（如可用）
size_bytes: number

存储文件的字节大小（如可用）

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "claude_chat_id": "claude_chat_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "md5": "md5",
  "mime_type": "mime_type",
  "size_bytes": 0
}

下载 Claude 生成的文件

get /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content

下载助手通过工具使用创建的文件的二进制内容。

路径参数

claude_gen_file_id: string

生成文件 ID（例如 'claude_gen_file_abc123'），在 GET /apps/chats/{claude_chat_id}/messages 的 chat_messages[].generated_files[].id 中返回。

请求头参数

"x-api-key": optional string

示例

curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID/content \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

领域类型

Generated File Retrieve Response

GeneratedFileRetrieveResponse object { id, claude_chat_id, created_at, 4 more }

GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id} 的元数据。

仅返回元数据。使用同级 /content 端点下载文件字节。包含所属聊天，因为 ID 是不透明的；要找到生成该文件的特定消息，请获取 /v1/compliance/apps/chats/{claude_chat_id}/messages 并匹配 generated_files[].id。
- id: string
  
  不透明的生成文件 ID，例如 'claude_gen_file_abc123'。
- claude_chat_id: string
  
  此生成文件所属的聊天
- created_at: string
  
  来自 Filestore 的文件创建时间戳
- filename: string
  
  生成文件的显示名称
- md5: string
  
  存储文件的小写十六进制 MD5，由 Filestore 记录。如果没有可用的存储哈希值，则为 null。同级 /content 端点还会设置一个 Content-MD5 请求头（按 RFC 1864 进行 base64 编码），基于实际提供的字节计算。
- mime_type: string
  
  Filestore 记录的 MIME 类型（如可用）
- size_bytes: number
  
  存储文件的字节大小（如可用）

Projects

列出项目

get /v1/compliance/apps/projects

列出项目元数据，支持过滤功能。结果按 created_at 时间顺序（升序）排列。

查询参数

created_at: optional object { gt, gte, lt, lte }
- gt: optional string
  
  过滤在此时间之后创建的项目（RFC 3339 格式）
- gte: optional string
  
  过滤在此时间或之后创建的项目（RFC 3339 格式）
- lt: optional string
  
  过滤在此时间之前创建的项目（RFC 3339 格式）
- lte: optional string
  
  过滤在此时间或之前创建的项目（RFC 3339 格式）
limit: optional number

最大结果数（默认：20，最大：100）
organization_ids: optional array of string

按组织 ID 过滤（接受 org_... 或组织 UUID）。可通过 GET /v1/compliance/organizations 枚举 ID。
page: optional string

来自上一次响应 next_page 字段的不透明分页令牌。传入此值以获取下一页结果。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。
user_ids: optional array of string

按用户 ID 过滤。可通过 GET /v1/compliance/organizations/{org_uuid}/users 枚举 ID。

请求头参数

"x-api-key": optional string

返回值

data: array of object { id, created_at, deleted_at, 6 more }

按创建日期升序排列的项目列表
- id: string
  
  项目标识符（带标签的 ID）
- created_at: string
  
  项目创建时间戳
- deleted_at: string
  
  项目被终端用户删除的时间戳，否则为 null
- is_private: boolean
  
  如果为 false，项目对所有组织成员可见；如果为 true，项目仅对创建者和指定的协作者可访问
- name: string
  
  项目名称
- organization_id: string
  
  组织标识符（带标签的 ID）
- organization_uuid: string
  
  此项目所属的组织 UUID
- updated_at: string
  
  项目最后更新时间戳
- user: object { id, email_address }
  
  项目创建者的用户信息。
  - id: string
    
    用户标识符（带标签的 ID）
  - email_address: string
    
    用户的电子邮件地址
has_more: boolean

当前结果集之外是否还有更多记录
next_page: string

用于获取下一页的令牌。在下一次请求中将其用作 'page' 参数

示例

curl https://api.anthropic.com/v1/compliance/apps/projects \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "data": [
    {
      "id": "claude_proj_abc123",
      "name": "Q4 Product Planning",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z",
      "is_private": true,
      "organization_id": "org_abc123",
      "organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
      "user": {
        "id": "user_xyz456",
        "email_address": "user@example.com"
      }
    }
  ],
  "has_more": true,
  "next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
}

获取项目详情

get /v1/compliance/apps/projects/{project_id}

获取特定项目的详细信息。

返回值：详细的项目信息，包括描述、指令和计数

路径参数

project_id: string

项目 ID（带标签的 ID，例如 claude_proj_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

项目标识符（带标签的 ID）
attachments_count: number

此项目中包含的附件数量
chats_count: number

此项目中包含的聊天数量
created_at: string

项目创建时间戳
deleted_at: string

项目被终端用户删除的时间戳，否则为 null
description: string

项目描述
instructions: string

项目的自定义指令/提示词
is_private: boolean

如果为 false，项目对所有组织成员可见；如果为 true，项目仅对创建者和指定的协作者可访问
name: string

项目名称
organization_id: string

组织标识符（带标签的 ID）
organization_uuid: string

此项目所属的组织 UUID
updated_at: string

项目最后更新时间戳
user: object { id, email_address }

项目创建者的用户信息。
- id: string
  
  用户标识符（带标签的 ID）
- email_address: string
  
  用户的电子邮件地址

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "attachments_count": 0,
  "chats_count": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "instructions": "instructions",
  "is_private": true,
  "name": "name",
  "organization_id": "organization_id",
  "organization_uuid": "organization_uuid",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

删除项目

delete /v1/compliance/apps/projects/{project_id}

出于合规目的删除项目。

硬删除项目及其所有关联数据，包括：

所有项目文档和文件
所有角色分配
知识库（如果启用了 RAG）
同步源

项目不能有附加的聊天 - 如果存在聊天，将返回 409。

返回值：确认删除的 ClaudeProjectDeleteResponse

抛出： ConflictException：如果项目有附加的聊天 NotFoundException：如果项目不存在或已被删除

路径参数

project_id: string

项目 ID（带标签的 ID，例如 claude_proj_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

已删除的 Claude 项目的 ID
type: optional "claude_project_deleted"

确认删除的常量字符串。
- "claude_project_deleted"

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "type": "claude_project_deleted"
}

领域类型

Project List Response

ProjectListResponse object { id, created_at, deleted_at, 6 more }

合规响应中的项目信息。
- id: string
  
  项目标识符（带标签的 ID）
- created_at: string
  
  项目创建时间戳
- deleted_at: string
  
  项目被终端用户删除的时间戳，否则为 null
- is_private: boolean
  
  如果为 false，项目对所有组织成员可见；如果为 true，项目仅对创建者和指定的协作者可访问
- name: string
  
  项目名称
- organization_id: string
  
  组织标识符（带标签的 ID）
- organization_uuid: string
  
  此项目所属的组织 UUID
- updated_at: string
  
  项目最后更新时间戳
- user: object { id, email_address }
  
  项目创建者的用户信息。
  - id: string
    
    用户标识符（带标签的 ID）
  - email_address: string
    
    用户的电子邮件地址

Project Retrieve Response

ProjectRetrieveResponse object { id, attachments_count, chats_count, 10 more }

合规响应中的详细项目信息。
- id: string
  
  项目标识符（带标签的 ID）
- attachments_count: number
  
  此项目中包含的附件数量
- chats_count: number
  
  此项目中包含的聊天数量
- created_at: string
  
  项目创建时间戳
- deleted_at: string
  
  项目被终端用户删除的时间戳，否则为 null
- description: string
  
  项目描述
- instructions: string
  
  项目的自定义指令/提示词
- is_private: boolean
  
  如果为 false，项目对所有组织成员可见；如果为 true，项目仅对创建者和指定的协作者可访问
- name: string
  
  项目名称
- organization_id: string
  
  组织标识符（带标签的 ID）
- organization_uuid: string
  
  此项目所属的组织 UUID
- updated_at: string
  
  项目最后更新时间戳
- user: object { id, email_address }
  
  项目创建者的用户信息。
  - id: string
    
    用户标识符（带标签的 ID）
  - email_address: string
    
    用户的电子邮件地址

Project Delete Response

ProjectDeleteResponse object { id, type }

删除 Claude 项目的响应。
- id: string
  
  已删除的 Claude 项目的 ID
- type: optional "claude_project_deleted"
  
  确认删除的常量字符串。
  - "claude_project_deleted"

Attachments

列出项目附件

get /v1/compliance/apps/projects/{project_id}/attachments

列出附加到项目的文件和文档。

列出附加到 project_id 引用的项目中的文件和项目文档。这包括附加文件的 ID 和附加项目文档的 ID。

附加文件的原始二进制内容可以使用 GET /v1/compliance/apps/chats/files/{claude_file_id}/content 端点下载。

附加项目文档的文本内容可以使用 GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} 端点获取。

返回值：带分页信息的项目附件列表

抛出： NotFoundException：如果项目不存在或 project_id 格式无效

路径参数

project_id: string

项目 ID（带标签的 ID，例如 claude_proj_abc123）

查询参数

limit: optional number

最大结果数（默认：20，最大：100）
page: optional string

来自上一次响应 next_page 字段的不透明分页令牌。传入此值以获取下一页结果。客户端应将此值视为不透明字符串，不要尝试解析或解释其内容，因为格式可能会在不另行通知的情况下更改。

请求头参数

"x-api-key": optional string

返回值

data: array of object { id, created_at, filename, 2 more } or object { id, created_at, filename, 2 more }

按 created_at 时间顺序排列的附件列表，相同时间按 id 排序
- ComplianceProjectFileReference object { id, created_at, filename, 2 more }
  
  合规响应中的文件附件引用。
  - id: string
    
    文件标识符（例如 'claude_file_abcd'）
  - created_at: string
    
    创建时间戳（RFC 3339 格式）
  - filename: string
    
    文件的显示名称（例如 'document.pdf'）
  - mime_type: string
    
    文件上传时的 MIME 类型（例如 'application/pdf'）
  - type: "project_file"
    
    标识此为二进制文件的鉴别器
    - "project_file"
- ComplianceProjectDocReference object { id, created_at, filename, 2 more }
  
  合规响应中的项目文档附件引用。
  - id: string
    
    项目文档标识符（例如 'claude_proj_doc_abcd'）
  - created_at: string
    
    创建时间戳（RFC 3339 格式）
  - filename: string
    
    文档的显示名称（例如 'document.txt'）
  - mime_type: "text/plain"
    
    项目文档的 MIME 类型，始终设置为纯文本
    - "text/plain"
  - type: "project_doc"
    
    标识此为纯文本文档的鉴别器
    - "project_doc"
has_more: boolean

当前结果集之外是否还有更多记录
next_page: string

要获取下一页，请将当前响应中的 'next_page' 用作下一次请求中的 'page'

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "filename",
      "mime_type": "mime_type",
      "type": "project_file"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

领域类型

Attachment List Response

AttachmentListResponse = object { id, created_at, filename, 2 more } or object { id, created_at, filename, 2 more }

合规响应中的文件附件引用。
- ComplianceProjectFileReference object { id, created_at, filename, 2 more }
  
  合规响应中的文件附件引用。
  - id: string
    
    文件标识符（例如 'claude_file_abcd'）
  - created_at: string
    
    创建时间戳（RFC 3339 格式）
  - filename: string
    
    文件的显示名称（例如 'document.pdf'）
  - mime_type: string
    
    文件上传时的 MIME 类型（例如 'application/pdf'）
  - type: "project_file"
    
    标识此为二进制文件的鉴别器
    - "project_file"
- ComplianceProjectDocReference object { id, created_at, filename, 2 more }
  
  合规响应中的项目文档附件引用。
  - id: string
    
    项目文档标识符（例如 'claude_proj_doc_abcd'）
  - created_at: string
    
    创建时间戳（RFC 3339 格式）
  - filename: string
    
    文档的显示名称（例如 'document.txt'）
  - mime_type: "text/plain"
    
    项目文档的 MIME 类型，始终设置为纯文本
    - "text/plain"
  - type: "project_doc"
    
    标识此为纯文本文档的鉴别器
    - "project_doc"

Documents

获取项目文档内容

get /v1/compliance/apps/projects/documents/{document_id}

获取特定项目文档的详细信息。

返回值：包含内容和元数据的项目文档信息

路径参数

document_id: string

文档 ID（带标签的 ID，例如 claude_proj_doc_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

项目文档标识符（带标签的 ID）
content: string

文档文本内容
created_at: string

文档创建时间戳
filename: string

文档文件名
user: object { id, email_address }

项目创建者的用户信息。
- id: string
  
  用户标识符（带标签的 ID）
- email_address: string
  
  用户的电子邮件地址

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "content": "content",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

获取项目文档元数据

get /v1/compliance/apps/projects/documents/{document_id}/metadata

返回项目文档的元数据，不包含内容正文。

使用同级 GET /v1/compliance/apps/projects/documents/{document_id} 端点获取文档文本。此处的 md5 和 size_bytes 字段是基于该文本的 UTF-8 编码计算的，因此 DLP 消费者可以在不下载每个文档的情况下进行去重或哈希匹配。

路径参数

document_id: string

文档 ID（带标签的 ID，例如 claude_proj_doc_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

项目文档标识符（带标签的 ID）
claude_project_id: string

此文档所属的项目
created_at: string

文档创建时间戳
filename: string

文档文件名
md5: string

文档内容的小写十六进制 MD5（UTF-8 编码）。与同级内容端点返回的 content 字段匹配。
mime_type: "text/plain"

文档内容的 MIME 类型，始终为纯文本
- "text/plain"
size_bytes: number

文档内容的字节大小（UTF-8 编码）
user: object { id, email_address }

项目创建者的用户信息。
- id: string
  
  用户标识符（带标签的 ID）
- email_address: string
  
  用户的电子邮件地址

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "claude_project_id": "claude_project_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "md5": "md5",
  "mime_type": "text/plain",
  "size_bytes": 0,
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

删除项目文档

delete /v1/compliance/apps/projects/documents/{document_id}

出于合规目的删除项目文档。

永久硬删除项目文档。

返回值：确认删除的 ComplianceProjectDocumentDeleteResponse

路径参数

document_id: string

文档 ID（带标签的 ID，例如 claude_proj_doc_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

已删除的项目文档的 ID
type: "claude_project_document_deleted"

确认删除的常量字符串。
- "claude_project_document_deleted"

示例

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "type": "claude_project_document_deleted"
}

领域类型

Document Retrieve Response

DocumentRetrieveResponse object { id, content, created_at, 2 more }

合规响应中的项目文档信息。
- id: string
  
  项目文档标识符（带标签的 ID）
- content: string
  
  文档文本内容
- created_at: string
  
  文档创建时间戳
- filename: string
  
  文档文件名
- user: object { id, email_address }
  
  项目创建者的用户信息。
  - id: string
    
    用户标识符（带标签的 ID）
  - email_address: string
    
    用户的电子邮件地址

Document Metadata Response

DocumentMetadataResponse object { id, claude_project_id, created_at, 5 more }

GET /v1/compliance/apps/projects/documents/{document_id}/metadata 的项目文档元数据。

仅返回元数据。使用同级端点（不带 /metadata）获取文档文本内容。
- id: string
  
  项目文档标识符（带标签的 ID）
- claude_project_id: string
  
  此文档所属的项目
- created_at: string
  
  文档创建时间戳
- filename: string
  
  文档文件名
- md5: string
  
  文档内容的小写十六进制 MD5（UTF-8 编码）。与同级内容端点返回的 content 字段匹配。
- mime_type: "text/plain"
  
  文档内容的 MIME 类型，始终为纯文本
  - "text/plain"
- size_bytes: number
  
  文档内容的字节大小（UTF-8 编码）
- user: object { id, email_address }
  
  项目创建者的用户信息。
  - id: string
    
    用户标识符（带标签的 ID）
  - email_address: string
    
    用户的电子邮件地址

Document Delete Response

DocumentDeleteResponse object { id, type }

删除项目文档的响应。
- id: string
  
  已删除的项目文档的 ID
- type: "claude_project_document_deleted"
  
  确认删除的常量字符串。
  - "claude_project_document_deleted"

Artifacts

获取制品元数据

get /v1/compliance/apps/artifacts/{artifact_version_id}

返回制品版本的元数据，不包含内容正文。

使用同级 /content 端点获取制品文本。此处的 md5 和 size_bytes 字段是基于该文本的 UTF-8 编码计算的，因此 DLP 消费者可以在不下载每个制品的情况下进行去重或哈希匹配。

路径参数

artifact_version_id: string

制品版本 ID（带标签的 ID，例如 claude_artifact_version_abc123）

请求头参数

"x-api-key": optional string

返回值

id: string

制品 ID，例如 'claude_artifact_abc123'
artifact_type: string

类似 MIME 的制品类型，例如 'application/vnd.ant.code'
claude_chat_id: string

此制品所属的聊天
created_at: string

制品版本创建时间戳
md5: string

制品内容的小写十六进制 MD5（UTF-8 编码）。与同级 /content 端点返回的 content 字段匹配。
size_bytes: number

制品内容的字节大小（UTF-8 编码）
title: string

制品标题
version_id: string

制品版本 ID，例如 'claude_artifact_version_abc123'

示例

curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

响应

{
  "id": "id",
  "artifact_type": "artifact_type",
  "claude_chat_id": "claude_chat_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "md5": "md5",
  "size_bytes": 0,
  "title": "title",
  "version_id": "version_id"
}

下载制品内容

get /v1/compliance/apps/artifacts/{artifact_version_id}/content

出于合规目的下载制品版本的内容。

返回制品版本的完整文本内容。

路径参数

artifact_version_id: string

制品版本 ID（带标签的 ID，例如 claude_artifact_version_abc123）

请求头参数

"x-api-key": optional string

示例

curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID/content \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

领域类型

Artifact Retrieve Response

ArtifactRetrieveResponse object { id, artifact_type, claude_chat_id, 5 more }

GET /v1/compliance/apps/artifacts/{artifact_version_id} 的制品版本元数据。

仅返回元数据。使用同级 /content 端点获取制品正文。
- id: string
  
  制品 ID，例如 'claude_artifact_abc123'
- artifact_type: string
  
  类似 MIME 的制品类型，例如 'application/vnd.ant.code'
- claude_chat_id: string
  
  此制品所属的聊天
- created_at: string
  
  制品版本创建时间戳
- md5: string
  
  制品内容的小写十六进制 MD5（UTF-8 编码）。与同级 /content 端点返回的 content 字段匹配。
- size_bytes: number
  
  制品内容的字节大小（UTF-8 编码）
- title: string
  
  制品标题
- version_id: string
  
  制品版本 ID，例如 'claude_artifact_version_abc123'