项目

列出项目

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"

附件

列出项目附件

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"

文档

获取项目文档内容

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"