Claude Platform Docs

To enable the Compliance API, see the setup guide.

Set up the Compliance 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}

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

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

Project document information for compliance responses.

id: string

Project document identifier (tagged ID)

content: string

Document text content

created_at: string

Document creation timestamp

formatdate-time
filename: string

Document filename

user: object{ id, email_address } or null

Document creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read

id: string

User identifier (tagged ID)

email_address: string

User's email address

DocumentDeleteResponse object{ type: "claude_project_document_deleted", id }

Response for deleting a project document.

type: "claude_project_document_deleted"

Constant string confirming deletion.

defaultclaude_project_document_deleted
id: string

The ID of the project document that was deleted

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

Project document metadata for GET /v1/compliance/apps/projects/documents/{document_id}/metadata.

Returns metadata only. Use the sibling endpoint (without /metadata) to fetch the document text content.