文档

获取项目文档内容

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"