To enable the Compliance API, see the setup guide.

Documentos

Obter conteúdo de documento do projeto

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

Obtém informações detalhadas de um documento de projeto específico.

Obter metadados de documento do projeto

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

Retorna metadados de um documento de projeto, sem o corpo do conteúdo.

Excluir documento do projeto

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

Exclui um documento de projeto para fins de conformidade.

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.